purecloudplatformclientv2 52.0.0 → 53.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 (2047) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/docs/ActionEntityListing.md +2 -2
  4. data/docs/ActionMap.md +30 -0
  5. data/docs/ActionMapAction.md +16 -0
  6. data/docs/ActionProperties.md +14 -0
  7. data/docs/ActionSurvey.md +13 -0
  8. data/docs/ActionTarget.md +15 -0
  9. data/docs/Activation.md +14 -0
  10. data/docs/AddShiftTradeRequest.md +17 -0
  11. data/docs/AgentActivityEntityListing.md +2 -2
  12. data/docs/AnalyticsApi.md +2 -2
  13. data/docs/AnalyticsConversationMultiGetResponse.md +13 -0
  14. data/docs/AnalyticsEvaluation.md +1 -1
  15. data/docs/AnalyticsSession.md +1 -0
  16. data/docs/ArchitectApi.md +88 -20
  17. data/docs/ArrayNode.md +6 -6
  18. data/docs/AttemptLimitsEntityListing.md +2 -2
  19. data/docs/AuthzDivisionEntityListing.md +2 -2
  20. data/docs/Browser.md +23 -0
  21. data/docs/CalibrationEntityListing.md +2 -2
  22. data/docs/Call.md +1 -0
  23. data/docs/CallBasic.md +1 -0
  24. data/docs/CallConversationEntityListing.md +2 -2
  25. data/docs/CallHistoryConversationEntityListing.md +2 -2
  26. data/docs/CallableTimeSetEntityListing.md +2 -2
  27. data/docs/Callback.md +1 -0
  28. data/docs/CallbackBasic.md +1 -0
  29. data/docs/CallbackConversationEntityListing.md +2 -2
  30. data/docs/CampaignDivisionViewListing.md +2 -2
  31. data/docs/CampaignEntityListing.md +2 -2
  32. data/docs/CampaignRuleEntityListing.md +2 -2
  33. data/docs/CampaignSequenceEntityListing.md +2 -2
  34. data/docs/CertificateAuthorityEntityListing.md +2 -2
  35. data/docs/ChatConversationEntityListing.md +2 -2
  36. data/docs/ChatMessage.md +7 -6
  37. data/docs/ClientAppEntityListing.md +2 -2
  38. data/docs/CobrowseConversationEntityListing.md +2 -2
  39. data/docs/Cobrowsesession.md +1 -0
  40. data/docs/CommandStatusEntityListing.md +2 -2
  41. data/docs/ConsumedResourcesEntityListing.md +2 -2
  42. data/docs/ConsumingResourcesEntityListing.md +2 -2
  43. data/docs/ContactListDivisionViewListing.md +2 -2
  44. data/docs/ContactListEntityListing.md +2 -2
  45. data/docs/ContactListFilterEntityListing.md +2 -2
  46. data/docs/ContactListing.md +2 -2
  47. data/docs/Context.md +13 -0
  48. data/docs/ContextPattern.md +13 -0
  49. data/docs/ConversationCallEventTopicCallMediaParticipant.md +1 -0
  50. data/docs/ConversationCallEventTopicJourneyAction.md +14 -0
  51. data/docs/ConversationCallEventTopicJourneyActionMap.md +14 -0
  52. data/docs/ConversationCallEventTopicJourneyContext.md +15 -0
  53. data/docs/ConversationCallEventTopicJourneyCustomer.md +14 -0
  54. data/docs/ConversationCallEventTopicJourneyCustomerSession.md +14 -0
  55. data/docs/ConversationCallbackEventTopicCallbackMediaParticipant.md +1 -0
  56. data/docs/ConversationCallbackEventTopicJourneyAction.md +14 -0
  57. data/docs/ConversationCallbackEventTopicJourneyActionMap.md +14 -0
  58. data/docs/ConversationCallbackEventTopicJourneyContext.md +15 -0
  59. data/docs/ConversationCallbackEventTopicJourneyCustomer.md +14 -0
  60. data/docs/ConversationCallbackEventTopicJourneyCustomerSession.md +14 -0
  61. data/docs/ConversationChat.md +1 -0
  62. data/docs/ConversationChatEventTopicChatMediaParticipant.md +1 -0
  63. data/docs/ConversationChatEventTopicJourneyAction.md +14 -0
  64. data/docs/ConversationChatEventTopicJourneyActionMap.md +14 -0
  65. data/docs/ConversationChatEventTopicJourneyContext.md +15 -0
  66. data/docs/ConversationChatEventTopicJourneyCustomer.md +14 -0
  67. data/docs/ConversationChatEventTopicJourneyCustomerSession.md +14 -0
  68. data/docs/ConversationCobrowseEventTopicCobrowseMediaParticipant.md +1 -0
  69. data/docs/ConversationCobrowseEventTopicJourneyAction.md +14 -0
  70. data/docs/ConversationCobrowseEventTopicJourneyActionMap.md +14 -0
  71. data/docs/ConversationCobrowseEventTopicJourneyContext.md +15 -0
  72. data/docs/ConversationCobrowseEventTopicJourneyCustomer.md +14 -0
  73. data/docs/ConversationCobrowseEventTopicJourneyCustomerSession.md +14 -0
  74. data/docs/ConversationEmailEventTopicEmailMediaParticipant.md +1 -0
  75. data/docs/ConversationEmailEventTopicJourneyAction.md +14 -0
  76. data/docs/ConversationEmailEventTopicJourneyActionMap.md +14 -0
  77. data/docs/ConversationEmailEventTopicJourneyContext.md +15 -0
  78. data/docs/ConversationEmailEventTopicJourneyCustomer.md +14 -0
  79. data/docs/ConversationEmailEventTopicJourneyCustomerSession.md +14 -0
  80. data/docs/ConversationEntityListing.md +2 -2
  81. data/docs/ConversationEventTopicChat.md +1 -0
  82. data/docs/ConversationEventTopicJourneyAction.md +14 -0
  83. data/docs/ConversationEventTopicJourneyActionMap.md +14 -0
  84. data/docs/ConversationEventTopicJourneyContext.md +15 -0
  85. data/docs/ConversationEventTopicJourneyCustomer.md +14 -0
  86. data/docs/ConversationEventTopicJourneyCustomerSession.md +14 -0
  87. data/docs/ConversationMessageEventTopicJourneyAction.md +14 -0
  88. data/docs/ConversationMessageEventTopicJourneyActionMap.md +14 -0
  89. data/docs/ConversationMessageEventTopicJourneyContext.md +15 -0
  90. data/docs/ConversationMessageEventTopicJourneyCustomer.md +14 -0
  91. data/docs/ConversationMessageEventTopicJourneyCustomerSession.md +14 -0
  92. data/docs/ConversationMessageEventTopicMessageMediaParticipant.md +1 -0
  93. data/docs/ConversationQuery.md +2 -2
  94. data/docs/ConversationScreenShareEventTopicJourneyAction.md +14 -0
  95. data/docs/ConversationScreenShareEventTopicJourneyActionMap.md +14 -0
  96. data/docs/ConversationScreenShareEventTopicJourneyContext.md +15 -0
  97. data/docs/ConversationScreenShareEventTopicJourneyCustomer.md +14 -0
  98. data/docs/ConversationScreenShareEventTopicJourneyCustomerSession.md +14 -0
  99. data/docs/ConversationScreenShareEventTopicScreenShareMediaParticipant.md +1 -0
  100. data/docs/ConversationSocialExpressionEventTopicJourneyAction.md +14 -0
  101. data/docs/ConversationSocialExpressionEventTopicJourneyActionMap.md +14 -0
  102. data/docs/ConversationSocialExpressionEventTopicJourneyContext.md +15 -0
  103. data/docs/ConversationSocialExpressionEventTopicJourneyCustomer.md +14 -0
  104. data/docs/ConversationSocialExpressionEventTopicJourneyCustomerSession.md +14 -0
  105. data/docs/ConversationSocialExpressionEventTopicSocialMediaParticipant.md +1 -0
  106. data/docs/ConversationVideoEventTopicJourneyAction.md +14 -0
  107. data/docs/ConversationVideoEventTopicJourneyActionMap.md +14 -0
  108. data/docs/ConversationVideoEventTopicJourneyContext.md +15 -0
  109. data/docs/ConversationVideoEventTopicJourneyCustomer.md +14 -0
  110. data/docs/ConversationVideoEventTopicJourneyCustomerSession.md +14 -0
  111. data/docs/ConversationVideoEventTopicVideoMediaParticipant.md +1 -0
  112. data/docs/ConversationsApi.md +2 -2
  113. data/docs/CreateManagementUnitSettings.md +1 -0
  114. data/docs/CredentialInfoListing.md +2 -2
  115. data/docs/CredentialTypeListing.md +2 -2
  116. data/docs/Criteria.md +16 -0
  117. data/docs/CurrentUserScheduleRequestBody.md +1 -0
  118. data/docs/Cursors.md +14 -0
  119. data/docs/CustomEventAttribute.md +14 -0
  120. data/docs/DIDEntityListing.md +2 -2
  121. data/docs/DIDPoolEntityListing.md +2 -2
  122. data/docs/DataTableRowEntityListing.md +2 -2
  123. data/docs/DataTablesDomainEntityListing.md +2 -2
  124. data/docs/DependencyObjectEntityListing.md +2 -2
  125. data/docs/DependencyTypeEntityListing.md +2 -2
  126. data/docs/Device.md +20 -0
  127. data/docs/DialerEventEntityListing.md +2 -2
  128. data/docs/DirectoryUserDevicesListing.md +2 -2
  129. data/docs/DncListDivisionViewListing.md +2 -2
  130. data/docs/DncListEntityListing.md +2 -2
  131. data/docs/Document.md +1 -1
  132. data/docs/DocumentAuditEntityListing.md +2 -2
  133. data/docs/DocumentEntityListing.md +2 -2
  134. data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +2 -2
  135. data/docs/DomainEntityListing.md +2 -2
  136. data/docs/DomainEntityListingEvaluationForm.md +2 -2
  137. data/docs/DomainEntityListingQueryResult.md +2 -2
  138. data/docs/DomainEntityListingSurveyForm.md +2 -2
  139. data/docs/EdgeEntityListing.md +2 -2
  140. data/docs/EdgeGroupEntityListing.md +2 -2
  141. data/docs/EdgeLineEntityListing.md +2 -2
  142. data/docs/Email.md +1 -0
  143. data/docs/EmailConversationEntityListing.md +2 -2
  144. data/docs/EmailMessageListing.md +2 -2
  145. data/docs/EmergencyGroupListing.md +2 -2
  146. data/docs/EncryptionKeyEntityListing.md +2 -2
  147. data/docs/EntityTypeCriteria.md +17 -0
  148. data/docs/EvaluationEntityListing.md +2 -2
  149. data/docs/EvaluationFormEntityListing.md +2 -2
  150. data/docs/EvaluatorActivityEntityListing.md +2 -2
  151. data/docs/Event.md +24 -0
  152. data/docs/EventAction.md +17 -0
  153. data/docs/EventCondition.md +15 -0
  154. data/docs/EventListing.md +16 -0
  155. data/docs/ExtensionEntityListing.md +2 -2
  156. data/docs/ExtensionPoolEntityListing.md +2 -2
  157. data/docs/ExternalOrganizationListing.md +2 -2
  158. data/docs/FacebookIntegrationEntityListing.md +2 -2
  159. data/docs/FaxDocument.md +1 -1
  160. data/docs/FaxDocumentEntityListing.md +2 -2
  161. data/docs/Flow.md +1 -1
  162. data/docs/FlowDivisionView.md +1 -1
  163. data/docs/FlowDivisionViewEntityListing.md +2 -2
  164. data/docs/FlowEntityListing.md +2 -2
  165. data/docs/FlowVersionEntityListing.md +2 -2
  166. data/docs/GDPRRequestEntityListing.md +2 -2
  167. data/docs/GDPRSubjectEntityListing.md +2 -2
  168. data/docs/GenericActionEvent.md +16 -0
  169. data/docs/GenericEventAction.md +18 -0
  170. data/docs/GreetingListing.md +2 -2
  171. data/docs/GroupEntityListing.md +2 -2
  172. data/docs/GroupProfileEntityListing.md +2 -2
  173. data/docs/HistoryEntry.md +18 -0
  174. data/docs/HistoryListing.md +5 -0
  175. data/docs/IVREntityListing.md +2 -2
  176. data/docs/InboundDomainEntityListing.md +2 -2
  177. data/docs/InboundRoute.md +2 -0
  178. data/docs/InboundRouteEntityListing.md +2 -2
  179. data/docs/IntegrationEntityListing.md +2 -2
  180. data/docs/IntegrationEventEntityListing.md +2 -2
  181. data/docs/IntegrationTypeEntityListing.md +2 -2
  182. data/docs/InteractionStatsAlertContainer.md +2 -2
  183. data/docs/InteractionStatsRuleContainer.md +2 -2
  184. data/docs/Journey.md +13 -0
  185. data/docs/JourneyAction.md +1 -1
  186. data/docs/JourneyApi.md +85 -0
  187. data/docs/JourneyCampaign.md +19 -0
  188. data/docs/JourneyContext.md +1 -1
  189. data/docs/JourneyGeolocation.md +22 -0
  190. data/docs/JourneyPage.md +22 -0
  191. data/docs/JourneyPattern.md +14 -0
  192. data/docs/JourneySegment.md +25 -0
  193. data/docs/JourneySurveyQuestion.md +17 -0
  194. data/docs/KeywordSetEntityListing.md +2 -2
  195. data/docs/LanguageEntityListing.md +2 -2
  196. data/docs/LibraryEntityListing.md +2 -2
  197. data/docs/LicenseApi.md +71 -0
  198. data/docs/LineBaseEntityListing.md +2 -2
  199. data/docs/LineEntityListing.md +2 -2
  200. data/docs/LineIntegrationEntityListing.md +2 -2
  201. data/docs/LineIntegrationRequest.md +3 -2
  202. data/docs/LocationEntityListing.md +2 -2
  203. data/docs/LogicalInterfaceEntityListing.md +2 -2
  204. data/docs/ManagementUnitListing.md +2 -2
  205. data/docs/ManagementUnitSettings.md +1 -0
  206. data/docs/MatchShiftTradeRequest.md +15 -0
  207. data/docs/MatchShiftTradeResponse.md +15 -0
  208. data/docs/Message.md +1 -0
  209. data/docs/MessageConversationEntityListing.md +2 -2
  210. data/docs/MessagingStickerEntityListing.md +2 -2
  211. data/docs/ModelingProcessingError.md +14 -0
  212. data/docs/ModelingStatusResponse.md +16 -0
  213. data/docs/NoteListing.md +2 -2
  214. data/docs/NotificationsResponse.md +13 -0
  215. data/docs/OAuthClientEntityListing.md +2 -2
  216. data/docs/OAuthProviderEntityListing.md +2 -2
  217. data/docs/ObservationMetricData.md +2 -0
  218. data/docs/ObservationQuery.md +1 -0
  219. data/docs/ObservationValue.md +26 -0
  220. data/docs/OrganizationPresenceEntityListing.md +2 -2
  221. data/docs/OrganizationRoleEntityListing.md +2 -2
  222. data/docs/OrphanRecordingListing.md +2 -2
  223. data/docs/OutboundRouteBaseEntityListing.md +2 -2
  224. data/docs/OutboundRouteEntityListing.md +2 -2
  225. data/docs/Outcome.md +24 -0
  226. data/docs/OutcomeAchievedEvent.md +22 -0
  227. data/docs/OutcomeProbabilityCondition.md +15 -0
  228. data/docs/PermissionCollectionEntityListing.md +2 -2
  229. data/docs/PhoneBaseEntityListing.md +2 -2
  230. data/docs/PhoneEntityListing.md +2 -2
  231. data/docs/PhoneMetaBaseEntityListing.md +2 -2
  232. data/docs/PhysicalInterfaceEntityListing.md +2 -2
  233. data/docs/PolicyEntityListing.md +2 -2
  234. data/docs/PromptAssetEntityListing.md +2 -2
  235. data/docs/PromptEntityListing.md +2 -2
  236. data/docs/QualityAuditPage.md +2 -2
  237. data/docs/QueueConversationCallEventTopicCallMediaParticipant.md +1 -0
  238. data/docs/QueueConversationCallEventTopicJourneyAction.md +14 -0
  239. data/docs/QueueConversationCallEventTopicJourneyActionMap.md +14 -0
  240. data/docs/QueueConversationCallEventTopicJourneyContext.md +15 -0
  241. data/docs/QueueConversationCallEventTopicJourneyCustomer.md +14 -0
  242. data/docs/QueueConversationCallEventTopicJourneyCustomerSession.md +14 -0
  243. data/docs/QueueConversationCallbackEventTopicCallbackMediaParticipant.md +1 -0
  244. data/docs/QueueConversationCallbackEventTopicJourneyAction.md +14 -0
  245. data/docs/QueueConversationCallbackEventTopicJourneyActionMap.md +14 -0
  246. data/docs/QueueConversationCallbackEventTopicJourneyContext.md +15 -0
  247. data/docs/QueueConversationCallbackEventTopicJourneyCustomer.md +14 -0
  248. data/docs/QueueConversationCallbackEventTopicJourneyCustomerSession.md +14 -0
  249. data/docs/QueueConversationChatEventTopicChatMediaParticipant.md +1 -0
  250. data/docs/QueueConversationChatEventTopicJourneyAction.md +14 -0
  251. data/docs/QueueConversationChatEventTopicJourneyActionMap.md +14 -0
  252. data/docs/QueueConversationChatEventTopicJourneyContext.md +15 -0
  253. data/docs/QueueConversationChatEventTopicJourneyCustomer.md +14 -0
  254. data/docs/QueueConversationChatEventTopicJourneyCustomerSession.md +14 -0
  255. data/docs/QueueConversationCobrowseEventTopicCobrowseMediaParticipant.md +1 -0
  256. data/docs/QueueConversationCobrowseEventTopicJourneyAction.md +14 -0
  257. data/docs/QueueConversationCobrowseEventTopicJourneyActionMap.md +14 -0
  258. data/docs/QueueConversationCobrowseEventTopicJourneyContext.md +15 -0
  259. data/docs/QueueConversationCobrowseEventTopicJourneyCustomer.md +14 -0
  260. data/docs/QueueConversationCobrowseEventTopicJourneyCustomerSession.md +14 -0
  261. data/docs/QueueConversationEmailEventTopicEmailMediaParticipant.md +1 -0
  262. data/docs/QueueConversationEmailEventTopicJourneyAction.md +14 -0
  263. data/docs/QueueConversationEmailEventTopicJourneyActionMap.md +14 -0
  264. data/docs/QueueConversationEmailEventTopicJourneyContext.md +15 -0
  265. data/docs/QueueConversationEmailEventTopicJourneyCustomer.md +14 -0
  266. data/docs/QueueConversationEmailEventTopicJourneyCustomerSession.md +14 -0
  267. data/docs/QueueConversationEventTopicChat.md +1 -0
  268. data/docs/QueueConversationEventTopicJourneyAction.md +14 -0
  269. data/docs/QueueConversationEventTopicJourneyActionMap.md +14 -0
  270. data/docs/QueueConversationEventTopicJourneyContext.md +15 -0
  271. data/docs/QueueConversationEventTopicJourneyCustomer.md +14 -0
  272. data/docs/QueueConversationEventTopicJourneyCustomerSession.md +14 -0
  273. data/docs/QueueConversationMessageEventTopicJourneyAction.md +14 -0
  274. data/docs/QueueConversationMessageEventTopicJourneyActionMap.md +14 -0
  275. data/docs/QueueConversationMessageEventTopicJourneyContext.md +15 -0
  276. data/docs/QueueConversationMessageEventTopicJourneyCustomer.md +14 -0
  277. data/docs/QueueConversationMessageEventTopicJourneyCustomerSession.md +14 -0
  278. data/docs/QueueConversationMessageEventTopicMessageMediaParticipant.md +1 -0
  279. data/docs/QueueConversationScreenShareEventTopicJourneyAction.md +14 -0
  280. data/docs/QueueConversationScreenShareEventTopicJourneyActionMap.md +14 -0
  281. data/docs/QueueConversationScreenShareEventTopicJourneyContext.md +15 -0
  282. data/docs/QueueConversationScreenShareEventTopicJourneyCustomer.md +14 -0
  283. data/docs/QueueConversationScreenShareEventTopicJourneyCustomerSession.md +14 -0
  284. data/docs/QueueConversationScreenShareEventTopicScreenShareMediaParticipant.md +1 -0
  285. data/docs/QueueConversationSocialExpressionEventTopicChat.md +1 -0
  286. data/docs/QueueConversationSocialExpressionEventTopicJourneyAction.md +14 -0
  287. data/docs/QueueConversationSocialExpressionEventTopicJourneyActionMap.md +14 -0
  288. data/docs/QueueConversationSocialExpressionEventTopicJourneyContext.md +15 -0
  289. data/docs/QueueConversationSocialExpressionEventTopicJourneyCustomer.md +14 -0
  290. data/docs/QueueConversationSocialExpressionEventTopicJourneyCustomerSession.md +14 -0
  291. data/docs/QueueConversationVideoEventTopicChat.md +1 -0
  292. data/docs/QueueConversationVideoEventTopicJourneyAction.md +14 -0
  293. data/docs/QueueConversationVideoEventTopicJourneyActionMap.md +14 -0
  294. data/docs/QueueConversationVideoEventTopicJourneyContext.md +15 -0
  295. data/docs/QueueConversationVideoEventTopicJourneyCustomer.md +14 -0
  296. data/docs/QueueConversationVideoEventTopicJourneyCustomerSession.md +14 -0
  297. data/docs/QueueEntityListing.md +2 -2
  298. data/docs/QueueMemberEntityListing.md +2 -2
  299. data/docs/RecipientListing.md +2 -2
  300. data/docs/Referrer.md +21 -0
  301. data/docs/RelationshipListing.md +2 -2
  302. data/docs/ReportMetaDataEntityListing.md +2 -2
  303. data/docs/ReportRunEntryEntityDomainListing.md +2 -2
  304. data/docs/ReportScheduleEntityListing.md +2 -2
  305. data/docs/ReportingExportJobListing.md +2 -2
  306. data/docs/ResponseEntityList.md +2 -2
  307. data/docs/ResponseEntityListing.md +2 -2
  308. data/docs/ResponseSetEntityListing.md +2 -2
  309. data/docs/RuleSetEntityListing.md +2 -2
  310. data/docs/ScheduleEntityListing.md +2 -2
  311. data/docs/ScheduleGroupEntityListing.md +2 -2
  312. data/docs/SchedulingProcessingError.md +14 -0
  313. data/docs/SchedulingStatusResponse.md +17 -0
  314. data/docs/SchemaCategoryEntityListing.md +2 -2
  315. data/docs/SchemaReferenceEntityListing.md +2 -2
  316. data/docs/ScreenRecordingSessionListing.md +2 -2
  317. data/docs/Screenshare.md +1 -0
  318. data/docs/ScriptEntityListing.md +2 -2
  319. data/docs/SearchShiftTradeResponse.md +15 -0
  320. data/docs/SearchShiftTradesRequest.md +14 -0
  321. data/docs/SearchShiftTradesResponse.md +13 -0
  322. data/docs/SecurityProfileEntityListing.md +2 -2
  323. data/docs/SegmentAssignedEvent.md +22 -0
  324. data/docs/Session.md +15 -0
  325. data/docs/ShareEntityListing.md +2 -2
  326. data/docs/ShiftTradeActivityPreviewResponse.md +16 -0
  327. data/docs/ShiftTradeActivityRule.md +15 -0
  328. data/docs/ShiftTradeListResponse.md +13 -0
  329. data/docs/ShiftTradeMatchReviewResponse.md +16 -0
  330. data/docs/ShiftTradeMatchReviewUserResponse.md +17 -0
  331. data/docs/ShiftTradeMatchViolation.md +14 -0
  332. data/docs/ShiftTradeMatchesSummaryResponse.md +13 -0
  333. data/docs/ShiftTradeNotification.md +20 -0
  334. data/docs/ShiftTradePreviewResponse.md +13 -0
  335. data/docs/ShiftTradeResponse.md +30 -0
  336. data/docs/ShiftTradeResponseAcceptableIntervals.md +14 -0
  337. data/docs/ShiftTradeSettings.md +24 -0
  338. data/docs/SiteEntityListing.md +2 -2
  339. data/docs/SkillEntityListing.md +2 -2
  340. data/docs/SmsPhoneNumberEntityListing.md +2 -2
  341. data/docs/SocialExpression.md +1 -0
  342. data/docs/StationEntityListing.md +2 -2
  343. data/docs/SubjectDivisionGrantsEntityListing.md +2 -2
  344. data/docs/SurveyFormEntityListing.md +2 -2
  345. data/docs/SystemPromptAssetEntityListing.md +2 -2
  346. data/docs/SystemPromptEntityListing.md +2 -2
  347. data/docs/TagValueEntityListing.md +2 -2
  348. data/docs/TextMessageListing.md +2 -2
  349. data/docs/TimeZoneEntityListing.md +2 -2
  350. data/docs/TrunkBaseEntityListing.md +2 -2
  351. data/docs/TrunkEntityListing.md +2 -2
  352. data/docs/TrunkMetabaseEntityListing.md +2 -2
  353. data/docs/TrustEntityListing.md +2 -2
  354. data/docs/TrustUserEntityListing.md +2 -2
  355. data/docs/TrustorEntityListing.md +2 -2
  356. data/docs/TwitterIntegrationEntityListing.md +2 -2
  357. data/docs/UpdateAgentRequest.md +13 -0
  358. data/docs/UpdateNotificationResponse.md +14 -0
  359. data/docs/UpdateNotificationsRequest.md +13 -0
  360. data/docs/UpdateNotificationsResponse.md +13 -0
  361. data/docs/UpdateShiftTradeRequest.md +16 -0
  362. data/docs/UpdateShiftTradeStateRequest.md +14 -0
  363. data/docs/UrlCondition.md +14 -0
  364. data/docs/UserActionCategoryEntityListing.md +2 -2
  365. data/docs/UserEntityListing.md +2 -2
  366. data/docs/UserLanguageEntityListing.md +2 -2
  367. data/docs/UserLicenses.md +15 -0
  368. data/docs/UserLicensesEntityListing.md +17 -0
  369. data/docs/UserListScheduleRequestBody.md +1 -0
  370. data/docs/UserProfileEntityListing.md +2 -2
  371. data/docs/UserQueueEntityListing.md +2 -2
  372. data/docs/UserRecordingEntityListing.md +2 -2
  373. data/docs/UserScheduleAdherence.md +2 -0
  374. data/docs/UserScheduleContainer.md +1 -0
  375. data/docs/UserScheduleShift.md +1 -0
  376. data/docs/UserSkillEntityListing.md +2 -2
  377. data/docs/Video.md +2 -0
  378. data/docs/ViewFilter.md +1 -0
  379. data/docs/VoicemailMessageEntityListing.md +2 -2
  380. data/docs/WebActionEvent.md +26 -0
  381. data/docs/WebChatApi.md +5 -5
  382. data/docs/WebEvent.md +25 -0
  383. data/docs/WeekSchedule.md +1 -1
  384. data/docs/WeekScheduleListItemResponse.md +1 -1
  385. data/docs/WeekScheduleReference.md +15 -0
  386. data/docs/WeekShiftTradeListResponse.md +13 -0
  387. data/docs/WeekShiftTradeMatchesSummaryResponse.md +14 -0
  388. data/docs/WeekShiftTradeResponse.md +14 -0
  389. data/docs/WfmAgent.md +1 -0
  390. data/docs/WfmAgentScheduleUpdateTopicWfmScheduleShift.md +3 -0
  391. data/docs/WfmUserNotification.md +20 -0
  392. data/docs/WfmUserNotificationTopicShiftTradeNotification.md +20 -0
  393. data/docs/WfmUserNotificationTopicUserReference.md +13 -0
  394. data/docs/WfmUserNotificationTopicWfmUserNotification.md +19 -0
  395. data/docs/WfmUserScheduleAdherenceUpdatedTopicQueueReference.md +13 -0
  396. data/docs/WfmUserScheduleAdherenceUpdatedTopicUserScheduleAdherenceUpdate.md +3 -0
  397. data/docs/WidgetClientConfig.md +15 -0
  398. data/docs/WidgetClientConfigThirdParty.md +12 -0
  399. data/docs/WidgetClientConfigV1.md +14 -0
  400. data/docs/WidgetClientConfigV2.md +12 -0
  401. data/docs/WidgetDeployment.md +22 -0
  402. data/docs/WidgetDeploymentEntityListing.md +15 -0
  403. data/docs/WidgetsApi.md +343 -0
  404. data/docs/WorkforceManagementApi.md +1456 -420
  405. data/docs/WorkspaceEntityListing.md +2 -2
  406. data/docs/WorkspaceMemberEntityListing.md +2 -2
  407. data/docs/WrapupCodeEntityListing.md +2 -2
  408. data/lib/purecloudplatformclientv2.rb +190 -3
  409. data/lib/purecloudplatformclientv2/api/alerting_api.rb +3 -3
  410. data/lib/purecloudplatformclientv2/api/analytics_api.rb +6 -6
  411. data/lib/purecloudplatformclientv2/api/architect_api.rb +107 -33
  412. data/lib/purecloudplatformclientv2/api/authorization_api.rb +3 -3
  413. data/lib/purecloudplatformclientv2/api/billing_api.rb +3 -3
  414. data/lib/purecloudplatformclientv2/api/content_management_api.rb +3 -3
  415. data/lib/purecloudplatformclientv2/api/conversations_api.rb +6 -6
  416. data/lib/purecloudplatformclientv2/api/external_contacts_api.rb +3 -3
  417. data/lib/purecloudplatformclientv2/api/fax_api.rb +3 -3
  418. data/lib/purecloudplatformclientv2/api/flows_api.rb +3 -3
  419. data/lib/purecloudplatformclientv2/api/general_data_protection_regulation_api.rb +3 -3
  420. data/lib/purecloudplatformclientv2/api/geolocation_api.rb +3 -3
  421. data/lib/purecloudplatformclientv2/api/greetings_api.rb +3 -3
  422. data/lib/purecloudplatformclientv2/api/groups_api.rb +3 -3
  423. data/lib/purecloudplatformclientv2/api/identity_provider_api.rb +3 -3
  424. data/lib/purecloudplatformclientv2/api/integrations_api.rb +3 -3
  425. data/lib/purecloudplatformclientv2/api/journey_api.rb +119 -0
  426. data/lib/purecloudplatformclientv2/api/languages_api.rb +3 -3
  427. data/lib/purecloudplatformclientv2/api/license_api.rb +76 -3
  428. data/lib/purecloudplatformclientv2/api/locations_api.rb +3 -3
  429. data/lib/purecloudplatformclientv2/api/messaging_api.rb +3 -3
  430. data/lib/purecloudplatformclientv2/api/mobile_devices_api.rb +3 -3
  431. data/lib/purecloudplatformclientv2/api/notifications_api.rb +3 -3
  432. data/lib/purecloudplatformclientv2/api/o_auth_api.rb +3 -3
  433. data/lib/purecloudplatformclientv2/api/objects_api.rb +3 -3
  434. data/lib/purecloudplatformclientv2/api/organization_api.rb +3 -3
  435. data/lib/purecloudplatformclientv2/api/organization_authorization_api.rb +3 -3
  436. data/lib/purecloudplatformclientv2/api/outbound_api.rb +3 -3
  437. data/lib/purecloudplatformclientv2/api/presence_api.rb +3 -3
  438. data/lib/purecloudplatformclientv2/api/quality_api.rb +3 -3
  439. data/lib/purecloudplatformclientv2/api/recording_api.rb +3 -3
  440. data/lib/purecloudplatformclientv2/api/response_management_api.rb +3 -3
  441. data/lib/purecloudplatformclientv2/api/routing_api.rb +3 -3
  442. data/lib/purecloudplatformclientv2/api/scripts_api.rb +3 -3
  443. data/lib/purecloudplatformclientv2/api/search_api.rb +3 -3
  444. data/lib/purecloudplatformclientv2/api/stations_api.rb +3 -3
  445. data/lib/purecloudplatformclientv2/api/suggest_api.rb +3 -3
  446. data/lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb +3 -3
  447. data/lib/purecloudplatformclientv2/api/tokens_api.rb +3 -3
  448. data/lib/purecloudplatformclientv2/api/user_recordings_api.rb +3 -3
  449. data/lib/purecloudplatformclientv2/api/users_api.rb +3 -3
  450. data/lib/purecloudplatformclientv2/api/utilities_api.rb +3 -3
  451. data/lib/purecloudplatformclientv2/api/voicemail_api.rb +3 -3
  452. data/lib/purecloudplatformclientv2/api/web_chat_api.rb +3 -3
  453. data/lib/purecloudplatformclientv2/api/widgets_api.rb +351 -0
  454. data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +1291 -160
  455. data/lib/purecloudplatformclientv2/api_client.rb +4 -4
  456. data/lib/purecloudplatformclientv2/api_error.rb +3 -3
  457. data/lib/purecloudplatformclientv2/models/action.rb +3 -3
  458. data/lib/purecloudplatformclientv2/models/action_config.rb +3 -3
  459. data/lib/purecloudplatformclientv2/models/action_contract.rb +3 -3
  460. data/lib/purecloudplatformclientv2/models/action_contract_input.rb +3 -3
  461. data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +16 -16
  462. data/lib/purecloudplatformclientv2/models/action_input.rb +3 -3
  463. data/lib/purecloudplatformclientv2/models/action_map.rb +666 -0
  464. data/lib/purecloudplatformclientv2/models/action_map_action.rb +299 -0
  465. data/lib/purecloudplatformclientv2/models/action_output.rb +3 -3
  466. data/lib/purecloudplatformclientv2/models/action_properties.rb +228 -0
  467. data/lib/purecloudplatformclientv2/models/action_survey.rb +209 -0
  468. data/lib/purecloudplatformclientv2/models/action_target.rb +253 -0
  469. data/lib/purecloudplatformclientv2/models/actions.rb +3 -3
  470. data/lib/purecloudplatformclientv2/models/activation.rb +233 -0
  471. data/lib/purecloudplatformclientv2/models/active_alert_count.rb +3 -3
  472. data/lib/purecloudplatformclientv2/models/activity_code.rb +3 -3
  473. data/lib/purecloudplatformclientv2/models/activity_code_container.rb +3 -3
  474. data/lib/purecloudplatformclientv2/models/acw_settings.rb +3 -3
  475. data/lib/purecloudplatformclientv2/models/add_shift_trade_request.rb +317 -0
  476. data/lib/purecloudplatformclientv2/models/additional_message.rb +3 -3
  477. data/lib/purecloudplatformclientv2/models/address.rb +3 -3
  478. data/lib/purecloudplatformclientv2/models/addressable_entity_user.rb +3 -3
  479. data/lib/purecloudplatformclientv2/models/addressable_license_definition.rb +3 -3
  480. data/lib/purecloudplatformclientv2/models/adfs.rb +3 -3
  481. data/lib/purecloudplatformclientv2/models/adherence_settings.rb +3 -3
  482. data/lib/purecloudplatformclientv2/models/adhoc_recording_topic_conversation_data.rb +3 -3
  483. data/lib/purecloudplatformclientv2/models/adhoc_recording_topic_lock_data.rb +3 -3
  484. data/lib/purecloudplatformclientv2/models/adhoc_recording_topic_recording_data_v2.rb +3 -3
  485. data/lib/purecloudplatformclientv2/models/adhoc_recording_topic_user_data.rb +3 -3
  486. data/lib/purecloudplatformclientv2/models/adhoc_recording_topic_workspace_data.rb +3 -3
  487. data/lib/purecloudplatformclientv2/models/adjacents.rb +3 -3
  488. data/lib/purecloudplatformclientv2/models/admin_time_off_request_patch.rb +3 -3
  489. data/lib/purecloudplatformclientv2/models/agent.rb +3 -3
  490. data/lib/purecloudplatformclientv2/models/agent_activity.rb +3 -3
  491. data/lib/purecloudplatformclientv2/models/agent_activity_changed_topic_agent_activity.rb +3 -3
  492. data/lib/purecloudplatformclientv2/models/agent_activity_changed_topic_organization_presence.rb +3 -3
  493. data/lib/purecloudplatformclientv2/models/agent_activity_changed_topic_out_of_office.rb +3 -3
  494. data/lib/purecloudplatformclientv2/models/agent_activity_changed_topic_presence.rb +3 -3
  495. data/lib/purecloudplatformclientv2/models/agent_activity_changed_topic_routing_status.rb +3 -3
  496. data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +16 -16
  497. data/lib/purecloudplatformclientv2/models/agent_evaluator_activity.rb +3 -3
  498. data/lib/purecloudplatformclientv2/models/agent_time_off_request_patch.rb +3 -3
  499. data/lib/purecloudplatformclientv2/models/aggregate_data_container.rb +3 -3
  500. data/lib/purecloudplatformclientv2/models/aggregate_metric_data.rb +3 -3
  501. data/lib/purecloudplatformclientv2/models/aggregate_query_response.rb +3 -3
  502. data/lib/purecloudplatformclientv2/models/aggregate_view_data.rb +3 -3
  503. data/lib/purecloudplatformclientv2/models/aggregation_query.rb +3 -3
  504. data/lib/purecloudplatformclientv2/models/aggregation_range.rb +3 -3
  505. data/lib/purecloudplatformclientv2/models/aggregation_result.rb +3 -3
  506. data/lib/purecloudplatformclientv2/models/aggregation_result_entry.rb +3 -3
  507. data/lib/purecloudplatformclientv2/models/analytics_conversation.rb +3 -3
  508. data/lib/purecloudplatformclientv2/models/analytics_conversation_multi_get_response.rb +203 -0
  509. data/lib/purecloudplatformclientv2/models/analytics_conversation_query_response.rb +3 -3
  510. data/lib/purecloudplatformclientv2/models/analytics_conversation_segment.rb +3 -3
  511. data/lib/purecloudplatformclientv2/models/analytics_evaluation.rb +16 -16
  512. data/lib/purecloudplatformclientv2/models/analytics_flow.rb +3 -3
  513. data/lib/purecloudplatformclientv2/models/analytics_flow_outcome.rb +3 -3
  514. data/lib/purecloudplatformclientv2/models/analytics_media_endpoint_stat.rb +3 -3
  515. data/lib/purecloudplatformclientv2/models/analytics_participant.rb +3 -3
  516. data/lib/purecloudplatformclientv2/models/analytics_property.rb +3 -3
  517. data/lib/purecloudplatformclientv2/models/analytics_query_aggregation.rb +3 -3
  518. data/lib/purecloudplatformclientv2/models/analytics_query_clause.rb +3 -3
  519. data/lib/purecloudplatformclientv2/models/analytics_query_filter.rb +3 -3
  520. data/lib/purecloudplatformclientv2/models/analytics_query_predicate.rb +5 -5
  521. data/lib/purecloudplatformclientv2/models/analytics_routing_status_record.rb +3 -3
  522. data/lib/purecloudplatformclientv2/models/analytics_session.rb +33 -7
  523. data/lib/purecloudplatformclientv2/models/analytics_session_metric.rb +3 -3
  524. data/lib/purecloudplatformclientv2/models/analytics_survey.rb +3 -3
  525. data/lib/purecloudplatformclientv2/models/analytics_user_detail.rb +3 -3
  526. data/lib/purecloudplatformclientv2/models/analytics_user_details_query_response.rb +3 -3
  527. data/lib/purecloudplatformclientv2/models/analytics_user_presence_record.rb +3 -3
  528. data/lib/purecloudplatformclientv2/models/analytics_view.rb +3 -3
  529. data/lib/purecloudplatformclientv2/models/annotation.rb +3 -3
  530. data/lib/purecloudplatformclientv2/models/answer_option.rb +3 -3
  531. data/lib/purecloudplatformclientv2/models/architect_dependency_tracking_build_notification_dependency_tracking_build_notification.rb +3 -3
  532. data/lib/purecloudplatformclientv2/models/architect_dependency_tracking_build_notification_home_organization.rb +3 -3
  533. data/lib/purecloudplatformclientv2/models/architect_dependency_tracking_build_notification_user.rb +3 -3
  534. data/lib/purecloudplatformclientv2/models/architect_flow_notification_architect_operation.rb +3 -3
  535. data/lib/purecloudplatformclientv2/models/architect_flow_notification_error_detail.rb +3 -3
  536. data/lib/purecloudplatformclientv2/models/architect_flow_notification_error_message_params.rb +3 -3
  537. data/lib/purecloudplatformclientv2/models/architect_flow_notification_flow_notification.rb +3 -3
  538. data/lib/purecloudplatformclientv2/models/architect_flow_notification_flow_version.rb +3 -3
  539. data/lib/purecloudplatformclientv2/models/architect_flow_notification_home_organization.rb +3 -3
  540. data/lib/purecloudplatformclientv2/models/architect_flow_notification_user.rb +3 -3
  541. data/lib/purecloudplatformclientv2/models/architect_flow_outcome_notification_architect_operation.rb +3 -3
  542. data/lib/purecloudplatformclientv2/models/architect_flow_outcome_notification_error_detail.rb +3 -3
  543. data/lib/purecloudplatformclientv2/models/architect_flow_outcome_notification_error_message_params.rb +3 -3
  544. data/lib/purecloudplatformclientv2/models/architect_flow_outcome_notification_flow_outcome_notification.rb +3 -3
  545. data/lib/purecloudplatformclientv2/models/architect_flow_outcome_notification_home_organization.rb +3 -3
  546. data/lib/purecloudplatformclientv2/models/architect_flow_outcome_notification_user.rb +3 -3
  547. data/lib/purecloudplatformclientv2/models/architect_prompt_notification_architect_operation.rb +3 -3
  548. data/lib/purecloudplatformclientv2/models/architect_prompt_notification_error_detail.rb +3 -3
  549. data/lib/purecloudplatformclientv2/models/architect_prompt_notification_error_message_params.rb +3 -3
  550. data/lib/purecloudplatformclientv2/models/architect_prompt_notification_home_organization.rb +3 -3
  551. data/lib/purecloudplatformclientv2/models/architect_prompt_notification_prompt_notification.rb +3 -3
  552. data/lib/purecloudplatformclientv2/models/architect_prompt_notification_user.rb +3 -3
  553. data/lib/purecloudplatformclientv2/models/architect_prompt_resource_notification_prompt_resource_notification.rb +3 -3
  554. data/lib/purecloudplatformclientv2/models/architect_system_prompt_resource_notification_system_prompt_resource_notification.rb +3 -3
  555. data/lib/purecloudplatformclientv2/models/archive_retention.rb +3 -3
  556. data/lib/purecloudplatformclientv2/models/array_node.rb +79 -79
  557. data/lib/purecloudplatformclientv2/models/assigned_wrapup_code.rb +3 -3
  558. data/lib/purecloudplatformclientv2/models/async_week_schedule_response.rb +3 -3
  559. data/lib/purecloudplatformclientv2/models/attachment.rb +3 -3
  560. data/lib/purecloudplatformclientv2/models/attempt_limits.rb +3 -3
  561. data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +16 -16
  562. data/lib/purecloudplatformclientv2/models/attribute.rb +3 -3
  563. data/lib/purecloudplatformclientv2/models/attribute_filter_item.rb +3 -3
  564. data/lib/purecloudplatformclientv2/models/audit_change.rb +3 -3
  565. data/lib/purecloudplatformclientv2/models/audit_entity.rb +3 -3
  566. data/lib/purecloudplatformclientv2/models/audit_entity_reference.rb +3 -3
  567. data/lib/purecloudplatformclientv2/models/audit_facet.rb +3 -3
  568. data/lib/purecloudplatformclientv2/models/audit_filter.rb +3 -3
  569. data/lib/purecloudplatformclientv2/models/audit_message.rb +3 -3
  570. data/lib/purecloudplatformclientv2/models/audit_query_response.rb +3 -3
  571. data/lib/purecloudplatformclientv2/models/audit_search_result.rb +3 -3
  572. data/lib/purecloudplatformclientv2/models/audit_user.rb +3 -3
  573. data/lib/purecloudplatformclientv2/models/authz_division.rb +3 -3
  574. data/lib/purecloudplatformclientv2/models/authz_division_entity_listing.rb +16 -16
  575. data/lib/purecloudplatformclientv2/models/authz_grant.rb +3 -3
  576. data/lib/purecloudplatformclientv2/models/authz_grant_policy.rb +3 -3
  577. data/lib/purecloudplatformclientv2/models/authz_grant_role.rb +3 -3
  578. data/lib/purecloudplatformclientv2/models/authz_subject.rb +3 -3
  579. data/lib/purecloudplatformclientv2/models/available_language_list.rb +3 -3
  580. data/lib/purecloudplatformclientv2/models/available_topic.rb +3 -3
  581. data/lib/purecloudplatformclientv2/models/available_topic_entity_listing.rb +3 -3
  582. data/lib/purecloudplatformclientv2/models/available_translations.rb +3 -3
  583. data/lib/purecloudplatformclientv2/models/batch_download_job_result.rb +3 -3
  584. data/lib/purecloudplatformclientv2/models/batch_download_job_status_result.rb +3 -3
  585. data/lib/purecloudplatformclientv2/models/batch_download_job_submission.rb +3 -3
  586. data/lib/purecloudplatformclientv2/models/batch_download_job_submission_result.rb +3 -3
  587. data/lib/purecloudplatformclientv2/models/batch_download_request.rb +3 -3
  588. data/lib/purecloudplatformclientv2/models/billing_usage.rb +3 -3
  589. data/lib/purecloudplatformclientv2/models/billing_usage_report.rb +3 -3
  590. data/lib/purecloudplatformclientv2/models/billing_usage_resource.rb +3 -3
  591. data/lib/purecloudplatformclientv2/models/biography.rb +3 -3
  592. data/lib/purecloudplatformclientv2/models/browser.rb +472 -0
  593. data/lib/purecloudplatformclientv2/models/bullseye.rb +3 -3
  594. data/lib/purecloudplatformclientv2/models/calibration.rb +3 -3
  595. data/lib/purecloudplatformclientv2/models/calibration_assignment.rb +3 -3
  596. data/lib/purecloudplatformclientv2/models/calibration_create.rb +3 -3
  597. data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +16 -16
  598. data/lib/purecloudplatformclientv2/models/call.rb +30 -4
  599. data/lib/purecloudplatformclientv2/models/call_basic.rb +30 -4
  600. data/lib/purecloudplatformclientv2/models/call_command.rb +3 -3
  601. data/lib/purecloudplatformclientv2/models/call_conversation.rb +3 -3
  602. data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +16 -16
  603. data/lib/purecloudplatformclientv2/models/call_forwarding.rb +3 -3
  604. data/lib/purecloudplatformclientv2/models/call_forwarding_event_call.rb +3 -3
  605. data/lib/purecloudplatformclientv2/models/call_forwarding_event_call_forwarding.rb +3 -3
  606. data/lib/purecloudplatformclientv2/models/call_forwarding_event_target.rb +3 -3
  607. data/lib/purecloudplatformclientv2/models/call_forwarding_event_user.rb +3 -3
  608. data/lib/purecloudplatformclientv2/models/call_history_conversation.rb +3 -3
  609. data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +16 -16
  610. data/lib/purecloudplatformclientv2/models/call_history_participant.rb +3 -3
  611. data/lib/purecloudplatformclientv2/models/call_media_participant.rb +3 -3
  612. data/lib/purecloudplatformclientv2/models/call_media_policy.rb +3 -3
  613. data/lib/purecloudplatformclientv2/models/call_media_policy_conditions.rb +3 -3
  614. data/lib/purecloudplatformclientv2/models/call_record.rb +3 -3
  615. data/lib/purecloudplatformclientv2/models/call_route.rb +3 -3
  616. data/lib/purecloudplatformclientv2/models/call_target.rb +3 -3
  617. data/lib/purecloudplatformclientv2/models/callable_contacts_diagnostic.rb +3 -3
  618. data/lib/purecloudplatformclientv2/models/callable_time.rb +3 -3
  619. data/lib/purecloudplatformclientv2/models/callable_time_set.rb +3 -3
  620. data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +16 -16
  621. data/lib/purecloudplatformclientv2/models/callback.rb +30 -4
  622. data/lib/purecloudplatformclientv2/models/callback_basic.rb +30 -4
  623. data/lib/purecloudplatformclientv2/models/callback_conversation.rb +3 -3
  624. data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +16 -16
  625. data/lib/purecloudplatformclientv2/models/callback_identifier.rb +3 -3
  626. data/lib/purecloudplatformclientv2/models/callback_media_participant.rb +3 -3
  627. data/lib/purecloudplatformclientv2/models/campaign.rb +3 -3
  628. data/lib/purecloudplatformclientv2/models/campaign_diagnostics.rb +3 -3
  629. data/lib/purecloudplatformclientv2/models/campaign_division_view.rb +3 -3
  630. data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +16 -16
  631. data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +16 -16
  632. data/lib/purecloudplatformclientv2/models/campaign_interaction.rb +3 -3
  633. data/lib/purecloudplatformclientv2/models/campaign_interactions.rb +3 -3
  634. data/lib/purecloudplatformclientv2/models/campaign_progress.rb +3 -3
  635. data/lib/purecloudplatformclientv2/models/campaign_rule.rb +3 -3
  636. data/lib/purecloudplatformclientv2/models/campaign_rule_action.rb +3 -3
  637. data/lib/purecloudplatformclientv2/models/campaign_rule_action_entities.rb +3 -3
  638. data/lib/purecloudplatformclientv2/models/campaign_rule_condition.rb +3 -3
  639. data/lib/purecloudplatformclientv2/models/campaign_rule_entities.rb +3 -3
  640. data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +16 -16
  641. data/lib/purecloudplatformclientv2/models/campaign_rule_parameters.rb +3 -3
  642. data/lib/purecloudplatformclientv2/models/campaign_schedule.rb +3 -3
  643. data/lib/purecloudplatformclientv2/models/campaign_sequence.rb +3 -3
  644. data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +16 -16
  645. data/lib/purecloudplatformclientv2/models/campaign_stats.rb +3 -3
  646. data/lib/purecloudplatformclientv2/models/campaign_time_slot.rb +3 -3
  647. data/lib/purecloudplatformclientv2/models/category.rb +3 -3
  648. data/lib/purecloudplatformclientv2/models/category_entity_listing.rb +3 -3
  649. data/lib/purecloudplatformclientv2/models/certificate.rb +3 -3
  650. data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +16 -16
  651. data/lib/purecloudplatformclientv2/models/certificate_details.rb +3 -3
  652. data/lib/purecloudplatformclientv2/models/change.rb +3 -3
  653. data/lib/purecloudplatformclientv2/models/change_my_password_request.rb +3 -3
  654. data/lib/purecloudplatformclientv2/models/change_password_request.rb +3 -3
  655. data/lib/purecloudplatformclientv2/models/channel.rb +3 -3
  656. data/lib/purecloudplatformclientv2/models/channel_entity_listing.rb +3 -3
  657. data/lib/purecloudplatformclientv2/models/channel_topic.rb +3 -3
  658. data/lib/purecloudplatformclientv2/models/channel_topic_entity_listing.rb +3 -3
  659. data/lib/purecloudplatformclientv2/models/chat.rb +3 -3
  660. data/lib/purecloudplatformclientv2/models/chat_badge_topic_badge_entity.rb +3 -3
  661. data/lib/purecloudplatformclientv2/models/chat_badge_topic_chat_badge.rb +3 -3
  662. data/lib/purecloudplatformclientv2/models/chat_conversation.rb +3 -3
  663. data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +16 -16
  664. data/lib/purecloudplatformclientv2/models/chat_media_participant.rb +3 -3
  665. data/lib/purecloudplatformclientv2/models/chat_media_policy.rb +3 -3
  666. data/lib/purecloudplatformclientv2/models/chat_media_policy_conditions.rb +3 -3
  667. data/lib/purecloudplatformclientv2/models/chat_message.rb +50 -4
  668. data/lib/purecloudplatformclientv2/models/chat_message_user.rb +3 -3
  669. data/lib/purecloudplatformclientv2/models/client_app.rb +3 -3
  670. data/lib/purecloudplatformclientv2/models/client_app_configuration_info.rb +3 -3
  671. data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +16 -16
  672. data/lib/purecloudplatformclientv2/models/cobrowse_conversation.rb +3 -3
  673. data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +16 -16
  674. data/lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb +3 -3
  675. data/lib/purecloudplatformclientv2/models/cobrowsesession.rb +30 -4
  676. data/lib/purecloudplatformclientv2/models/command_status.rb +3 -3
  677. data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +16 -16
  678. data/lib/purecloudplatformclientv2/models/condition.rb +3 -3
  679. data/lib/purecloudplatformclientv2/models/connect_rate.rb +3 -3
  680. data/lib/purecloudplatformclientv2/models/consult_transfer.rb +3 -3
  681. data/lib/purecloudplatformclientv2/models/consult_transfer_response.rb +3 -3
  682. data/lib/purecloudplatformclientv2/models/consult_transfer_update.rb +3 -3
  683. data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +16 -16
  684. data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +16 -16
  685. data/lib/purecloudplatformclientv2/models/contact.rb +3 -3
  686. data/lib/purecloudplatformclientv2/models/contact_address.rb +3 -3
  687. data/lib/purecloudplatformclientv2/models/contact_callback_request.rb +3 -3
  688. data/lib/purecloudplatformclientv2/models/contact_column_time_zone.rb +3 -3
  689. data/lib/purecloudplatformclientv2/models/contact_column_to_data_action_field_mapping.rb +3 -3
  690. data/lib/purecloudplatformclientv2/models/contact_list.rb +3 -3
  691. data/lib/purecloudplatformclientv2/models/contact_list_division_view.rb +3 -3
  692. data/lib/purecloudplatformclientv2/models/contact_list_division_view_listing.rb +16 -16
  693. data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +16 -16
  694. data/lib/purecloudplatformclientv2/models/contact_list_filter.rb +3 -3
  695. data/lib/purecloudplatformclientv2/models/contact_list_filter_clause.rb +3 -3
  696. data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +16 -16
  697. data/lib/purecloudplatformclientv2/models/contact_list_filter_predicate.rb +3 -3
  698. data/lib/purecloudplatformclientv2/models/contact_list_filter_range.rb +3 -3
  699. data/lib/purecloudplatformclientv2/models/contact_listing.rb +16 -16
  700. data/lib/purecloudplatformclientv2/models/contact_phone_number_column.rb +3 -3
  701. data/lib/purecloudplatformclientv2/models/contact_sort.rb +3 -3
  702. data/lib/purecloudplatformclientv2/models/contactlist_download_ready_export_uri.rb +3 -3
  703. data/lib/purecloudplatformclientv2/models/contactlist_import_status_import_status.rb +3 -3
  704. data/lib/purecloudplatformclientv2/models/content_attribute_filter_item.rb +3 -3
  705. data/lib/purecloudplatformclientv2/models/content_facet_filter_item.rb +3 -3
  706. data/lib/purecloudplatformclientv2/models/content_filter_item.rb +3 -3
  707. data/lib/purecloudplatformclientv2/models/content_management_single_document_topic_document_data_v2.rb +3 -3
  708. data/lib/purecloudplatformclientv2/models/content_management_single_document_topic_lock_data.rb +3 -3
  709. data/lib/purecloudplatformclientv2/models/content_management_single_document_topic_user_data.rb +3 -3
  710. data/lib/purecloudplatformclientv2/models/content_management_single_document_topic_workspace_data.rb +3 -3
  711. data/lib/purecloudplatformclientv2/models/content_management_workspace_documents_topic_document_data_v2.rb +3 -3
  712. data/lib/purecloudplatformclientv2/models/content_management_workspace_documents_topic_lock_data.rb +3 -3
  713. data/lib/purecloudplatformclientv2/models/content_management_workspace_documents_topic_user_data.rb +3 -3
  714. data/lib/purecloudplatformclientv2/models/content_management_workspace_documents_topic_workspace_data.rb +3 -3
  715. data/lib/purecloudplatformclientv2/models/content_query_request.rb +3 -3
  716. data/lib/purecloudplatformclientv2/models/content_sort_item.rb +3 -3
  717. data/lib/purecloudplatformclientv2/models/context.rb +209 -0
  718. data/lib/purecloudplatformclientv2/models/context_pattern.rb +209 -0
  719. data/lib/purecloudplatformclientv2/models/conversation.rb +3 -3
  720. data/lib/purecloudplatformclientv2/models/conversation_association.rb +3 -3
  721. data/lib/purecloudplatformclientv2/models/conversation_basic.rb +3 -3
  722. data/lib/purecloudplatformclientv2/models/conversation_call_event_topic_call_conversation.rb +3 -3
  723. data/lib/purecloudplatformclientv2/models/conversation_call_event_topic_call_media_participant.rb +29 -4
  724. data/lib/purecloudplatformclientv2/models/conversation_call_event_topic_detail.rb +3 -3
  725. data/lib/purecloudplatformclientv2/models/conversation_call_event_topic_error_body.rb +3 -3
  726. data/lib/purecloudplatformclientv2/models/conversation_call_event_topic_fax_status.rb +3 -3
  727. data/lib/purecloudplatformclientv2/models/conversation_call_event_topic_journey_action.rb +226 -0
  728. data/lib/purecloudplatformclientv2/models/conversation_call_event_topic_journey_action_map.rb +226 -0
  729. data/lib/purecloudplatformclientv2/models/conversation_call_event_topic_journey_context.rb +251 -0
  730. data/lib/purecloudplatformclientv2/models/conversation_call_event_topic_journey_customer.rb +226 -0
  731. data/lib/purecloudplatformclientv2/models/conversation_call_event_topic_journey_customer_session.rb +226 -0
  732. data/lib/purecloudplatformclientv2/models/conversation_call_event_topic_uri_reference.rb +3 -3
  733. data/lib/purecloudplatformclientv2/models/conversation_call_event_topic_wrapup.rb +3 -3
  734. data/lib/purecloudplatformclientv2/models/conversation_callback_event_topic_callback_conversation.rb +3 -3
  735. data/lib/purecloudplatformclientv2/models/conversation_callback_event_topic_callback_media_participant.rb +29 -4
  736. data/lib/purecloudplatformclientv2/models/conversation_callback_event_topic_detail.rb +3 -3
  737. data/lib/purecloudplatformclientv2/models/conversation_callback_event_topic_dialer_preview.rb +3 -3
  738. data/lib/purecloudplatformclientv2/models/conversation_callback_event_topic_error_body.rb +3 -3
  739. data/lib/purecloudplatformclientv2/models/conversation_callback_event_topic_journey_action.rb +226 -0
  740. data/lib/purecloudplatformclientv2/models/conversation_callback_event_topic_journey_action_map.rb +226 -0
  741. data/lib/purecloudplatformclientv2/models/conversation_callback_event_topic_journey_context.rb +251 -0
  742. data/lib/purecloudplatformclientv2/models/conversation_callback_event_topic_journey_customer.rb +226 -0
  743. data/lib/purecloudplatformclientv2/models/conversation_callback_event_topic_journey_customer_session.rb +226 -0
  744. data/lib/purecloudplatformclientv2/models/conversation_callback_event_topic_phone_number_column.rb +3 -3
  745. data/lib/purecloudplatformclientv2/models/conversation_callback_event_topic_uri_reference.rb +3 -3
  746. data/lib/purecloudplatformclientv2/models/conversation_callback_event_topic_voicemail.rb +3 -3
  747. data/lib/purecloudplatformclientv2/models/conversation_callback_event_topic_wrapup.rb +3 -3
  748. data/lib/purecloudplatformclientv2/models/conversation_chat.rb +30 -4
  749. data/lib/purecloudplatformclientv2/models/conversation_chat_event_topic_chat_conversation.rb +3 -3
  750. data/lib/purecloudplatformclientv2/models/conversation_chat_event_topic_chat_media_participant.rb +29 -4
  751. data/lib/purecloudplatformclientv2/models/conversation_chat_event_topic_detail.rb +3 -3
  752. data/lib/purecloudplatformclientv2/models/conversation_chat_event_topic_error_body.rb +3 -3
  753. data/lib/purecloudplatformclientv2/models/conversation_chat_event_topic_journey_action.rb +226 -0
  754. data/lib/purecloudplatformclientv2/models/conversation_chat_event_topic_journey_action_map.rb +226 -0
  755. data/lib/purecloudplatformclientv2/models/conversation_chat_event_topic_journey_context.rb +251 -0
  756. data/lib/purecloudplatformclientv2/models/conversation_chat_event_topic_journey_customer.rb +226 -0
  757. data/lib/purecloudplatformclientv2/models/conversation_chat_event_topic_journey_customer_session.rb +226 -0
  758. data/lib/purecloudplatformclientv2/models/conversation_chat_event_topic_uri_reference.rb +3 -3
  759. data/lib/purecloudplatformclientv2/models/conversation_chat_event_topic_wrapup.rb +3 -3
  760. data/lib/purecloudplatformclientv2/models/conversation_cobrowse_event_topic_cobrowse_conversation.rb +3 -3
  761. data/lib/purecloudplatformclientv2/models/conversation_cobrowse_event_topic_cobrowse_media_participant.rb +29 -4
  762. data/lib/purecloudplatformclientv2/models/conversation_cobrowse_event_topic_detail.rb +3 -3
  763. data/lib/purecloudplatformclientv2/models/conversation_cobrowse_event_topic_error_body.rb +3 -3
  764. data/lib/purecloudplatformclientv2/models/conversation_cobrowse_event_topic_journey_action.rb +226 -0
  765. data/lib/purecloudplatformclientv2/models/conversation_cobrowse_event_topic_journey_action_map.rb +226 -0
  766. data/lib/purecloudplatformclientv2/models/conversation_cobrowse_event_topic_journey_context.rb +251 -0
  767. data/lib/purecloudplatformclientv2/models/conversation_cobrowse_event_topic_journey_customer.rb +226 -0
  768. data/lib/purecloudplatformclientv2/models/conversation_cobrowse_event_topic_journey_customer_session.rb +226 -0
  769. data/lib/purecloudplatformclientv2/models/conversation_cobrowse_event_topic_uri_reference.rb +3 -3
  770. data/lib/purecloudplatformclientv2/models/conversation_cobrowse_event_topic_wrapup.rb +3 -3
  771. data/lib/purecloudplatformclientv2/models/conversation_division_membership.rb +3 -3
  772. data/lib/purecloudplatformclientv2/models/conversation_email_event_topic_attachment.rb +3 -3
  773. data/lib/purecloudplatformclientv2/models/conversation_email_event_topic_detail.rb +3 -3
  774. data/lib/purecloudplatformclientv2/models/conversation_email_event_topic_email_conversation.rb +3 -3
  775. data/lib/purecloudplatformclientv2/models/conversation_email_event_topic_email_media_participant.rb +29 -4
  776. data/lib/purecloudplatformclientv2/models/conversation_email_event_topic_error_body.rb +3 -3
  777. data/lib/purecloudplatformclientv2/models/conversation_email_event_topic_journey_action.rb +226 -0
  778. data/lib/purecloudplatformclientv2/models/conversation_email_event_topic_journey_action_map.rb +226 -0
  779. data/lib/purecloudplatformclientv2/models/conversation_email_event_topic_journey_context.rb +251 -0
  780. data/lib/purecloudplatformclientv2/models/conversation_email_event_topic_journey_customer.rb +226 -0
  781. data/lib/purecloudplatformclientv2/models/conversation_email_event_topic_journey_customer_session.rb +226 -0
  782. data/lib/purecloudplatformclientv2/models/conversation_email_event_topic_uri_reference.rb +3 -3
  783. data/lib/purecloudplatformclientv2/models/conversation_email_event_topic_wrapup.rb +3 -3
  784. data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +16 -16
  785. data/lib/purecloudplatformclientv2/models/conversation_event_topic_address.rb +3 -3
  786. data/lib/purecloudplatformclientv2/models/conversation_event_topic_attachment.rb +3 -3
  787. data/lib/purecloudplatformclientv2/models/conversation_event_topic_call.rb +3 -3
  788. data/lib/purecloudplatformclientv2/models/conversation_event_topic_callback.rb +3 -3
  789. data/lib/purecloudplatformclientv2/models/conversation_event_topic_chat.rb +29 -4
  790. data/lib/purecloudplatformclientv2/models/conversation_event_topic_cobrowse.rb +3 -3
  791. data/lib/purecloudplatformclientv2/models/conversation_event_topic_conversation.rb +3 -3
  792. data/lib/purecloudplatformclientv2/models/conversation_event_topic_dialer_preview.rb +3 -3
  793. data/lib/purecloudplatformclientv2/models/conversation_event_topic_disconnect_reason.rb +3 -3
  794. data/lib/purecloudplatformclientv2/models/conversation_event_topic_email.rb +3 -3
  795. data/lib/purecloudplatformclientv2/models/conversation_event_topic_error_details.rb +3 -3
  796. data/lib/purecloudplatformclientv2/models/conversation_event_topic_fax_status.rb +3 -3
  797. data/lib/purecloudplatformclientv2/models/conversation_event_topic_journey_action.rb +226 -0
  798. data/lib/purecloudplatformclientv2/models/conversation_event_topic_journey_action_map.rb +226 -0
  799. data/lib/purecloudplatformclientv2/models/conversation_event_topic_journey_context.rb +251 -0
  800. data/lib/purecloudplatformclientv2/models/conversation_event_topic_journey_customer.rb +226 -0
  801. data/lib/purecloudplatformclientv2/models/conversation_event_topic_journey_customer_session.rb +226 -0
  802. data/lib/purecloudplatformclientv2/models/conversation_event_topic_message.rb +3 -3
  803. data/lib/purecloudplatformclientv2/models/conversation_event_topic_message_details.rb +3 -3
  804. data/lib/purecloudplatformclientv2/models/conversation_event_topic_message_media.rb +3 -3
  805. data/lib/purecloudplatformclientv2/models/conversation_event_topic_message_sticker.rb +3 -3
  806. data/lib/purecloudplatformclientv2/models/conversation_event_topic_participant.rb +3 -3
  807. data/lib/purecloudplatformclientv2/models/conversation_event_topic_phone_number_column.rb +3 -3
  808. data/lib/purecloudplatformclientv2/models/conversation_event_topic_screenshare.rb +3 -3
  809. data/lib/purecloudplatformclientv2/models/conversation_event_topic_social_expression.rb +3 -3
  810. data/lib/purecloudplatformclientv2/models/conversation_event_topic_video.rb +3 -3
  811. data/lib/purecloudplatformclientv2/models/conversation_event_topic_voicemail.rb +3 -3
  812. data/lib/purecloudplatformclientv2/models/conversation_event_topic_wrapup.rb +3 -3
  813. data/lib/purecloudplatformclientv2/models/conversation_message_event_topic_detail.rb +3 -3
  814. data/lib/purecloudplatformclientv2/models/conversation_message_event_topic_error_body.rb +3 -3
  815. data/lib/purecloudplatformclientv2/models/conversation_message_event_topic_journey_action.rb +226 -0
  816. data/lib/purecloudplatformclientv2/models/conversation_message_event_topic_journey_action_map.rb +226 -0
  817. data/lib/purecloudplatformclientv2/models/conversation_message_event_topic_journey_context.rb +251 -0
  818. data/lib/purecloudplatformclientv2/models/conversation_message_event_topic_journey_customer.rb +226 -0
  819. data/lib/purecloudplatformclientv2/models/conversation_message_event_topic_journey_customer_session.rb +226 -0
  820. data/lib/purecloudplatformclientv2/models/conversation_message_event_topic_message_conversation.rb +3 -3
  821. data/lib/purecloudplatformclientv2/models/conversation_message_event_topic_message_details.rb +3 -3
  822. data/lib/purecloudplatformclientv2/models/conversation_message_event_topic_message_media.rb +3 -3
  823. data/lib/purecloudplatformclientv2/models/conversation_message_event_topic_message_media_participant.rb +29 -4
  824. data/lib/purecloudplatformclientv2/models/conversation_message_event_topic_message_sticker.rb +3 -3
  825. data/lib/purecloudplatformclientv2/models/conversation_message_event_topic_uri_reference.rb +3 -3
  826. data/lib/purecloudplatformclientv2/models/conversation_message_event_topic_wrapup.rb +3 -3
  827. data/lib/purecloudplatformclientv2/models/conversation_properties.rb +3 -3
  828. data/lib/purecloudplatformclientv2/models/conversation_query.rb +49 -49
  829. data/lib/purecloudplatformclientv2/models/conversation_screen_share_event_topic_detail.rb +3 -3
  830. data/lib/purecloudplatformclientv2/models/conversation_screen_share_event_topic_error_body.rb +3 -3
  831. data/lib/purecloudplatformclientv2/models/conversation_screen_share_event_topic_journey_action.rb +226 -0
  832. data/lib/purecloudplatformclientv2/models/conversation_screen_share_event_topic_journey_action_map.rb +226 -0
  833. data/lib/purecloudplatformclientv2/models/conversation_screen_share_event_topic_journey_context.rb +251 -0
  834. data/lib/purecloudplatformclientv2/models/conversation_screen_share_event_topic_journey_customer.rb +226 -0
  835. data/lib/purecloudplatformclientv2/models/conversation_screen_share_event_topic_journey_customer_session.rb +226 -0
  836. data/lib/purecloudplatformclientv2/models/conversation_screen_share_event_topic_screen_share_conversation.rb +3 -3
  837. data/lib/purecloudplatformclientv2/models/conversation_screen_share_event_topic_screen_share_media_participant.rb +29 -4
  838. data/lib/purecloudplatformclientv2/models/conversation_screen_share_event_topic_uri_reference.rb +3 -3
  839. data/lib/purecloudplatformclientv2/models/conversation_screen_share_event_topic_wrapup.rb +3 -3
  840. data/lib/purecloudplatformclientv2/models/conversation_social_expression_event_topic_detail.rb +3 -3
  841. data/lib/purecloudplatformclientv2/models/conversation_social_expression_event_topic_error_body.rb +3 -3
  842. data/lib/purecloudplatformclientv2/models/conversation_social_expression_event_topic_journey_action.rb +226 -0
  843. data/lib/purecloudplatformclientv2/models/conversation_social_expression_event_topic_journey_action_map.rb +226 -0
  844. data/lib/purecloudplatformclientv2/models/conversation_social_expression_event_topic_journey_context.rb +251 -0
  845. data/lib/purecloudplatformclientv2/models/conversation_social_expression_event_topic_journey_customer.rb +226 -0
  846. data/lib/purecloudplatformclientv2/models/conversation_social_expression_event_topic_journey_customer_session.rb +226 -0
  847. data/lib/purecloudplatformclientv2/models/conversation_social_expression_event_topic_social_conversation.rb +3 -3
  848. data/lib/purecloudplatformclientv2/models/conversation_social_expression_event_topic_social_media_participant.rb +29 -4
  849. data/lib/purecloudplatformclientv2/models/conversation_social_expression_event_topic_uri_reference.rb +3 -3
  850. data/lib/purecloudplatformclientv2/models/conversation_social_expression_event_topic_wrapup.rb +3 -3
  851. data/lib/purecloudplatformclientv2/models/conversation_video_event_topic_detail.rb +3 -3
  852. data/lib/purecloudplatformclientv2/models/conversation_video_event_topic_error_body.rb +3 -3
  853. data/lib/purecloudplatformclientv2/models/conversation_video_event_topic_journey_action.rb +226 -0
  854. data/lib/purecloudplatformclientv2/models/conversation_video_event_topic_journey_action_map.rb +226 -0
  855. data/lib/purecloudplatformclientv2/models/conversation_video_event_topic_journey_context.rb +251 -0
  856. data/lib/purecloudplatformclientv2/models/conversation_video_event_topic_journey_customer.rb +226 -0
  857. data/lib/purecloudplatformclientv2/models/conversation_video_event_topic_journey_customer_session.rb +226 -0
  858. data/lib/purecloudplatformclientv2/models/conversation_video_event_topic_uri_reference.rb +3 -3
  859. data/lib/purecloudplatformclientv2/models/conversation_video_event_topic_video_conversation.rb +3 -3
  860. data/lib/purecloudplatformclientv2/models/conversation_video_event_topic_video_media_participant.rb +29 -4
  861. data/lib/purecloudplatformclientv2/models/conversation_video_event_topic_wrapup.rb +3 -3
  862. data/lib/purecloudplatformclientv2/models/copy_short_term_forecast_request.rb +3 -3
  863. data/lib/purecloudplatformclientv2/models/copy_voicemail_message.rb +3 -3
  864. data/lib/purecloudplatformclientv2/models/copy_week_schedule_request.rb +3 -3
  865. data/lib/purecloudplatformclientv2/models/copy_work_plan.rb +3 -3
  866. data/lib/purecloudplatformclientv2/models/cover_sheet.rb +3 -3
  867. data/lib/purecloudplatformclientv2/models/create_activity_code_request.rb +3 -3
  868. data/lib/purecloudplatformclientv2/models/create_admin_time_off_request.rb +3 -3
  869. data/lib/purecloudplatformclientv2/models/create_agent_time_off_request.rb +3 -3
  870. data/lib/purecloudplatformclientv2/models/create_call_request.rb +3 -3
  871. data/lib/purecloudplatformclientv2/models/create_call_response.rb +3 -3
  872. data/lib/purecloudplatformclientv2/models/create_callback_command.rb +3 -3
  873. data/lib/purecloudplatformclientv2/models/create_callback_on_conversation_command.rb +3 -3
  874. data/lib/purecloudplatformclientv2/models/create_callback_response.rb +3 -3
  875. data/lib/purecloudplatformclientv2/models/create_email_request.rb +3 -3
  876. data/lib/purecloudplatformclientv2/models/create_integration_request.rb +3 -3
  877. data/lib/purecloudplatformclientv2/models/create_management_unit_api_request.rb +3 -3
  878. data/lib/purecloudplatformclientv2/models/create_management_unit_settings.rb +33 -7
  879. data/lib/purecloudplatformclientv2/models/create_outbound_messaging_conversation_request.rb +3 -3
  880. data/lib/purecloudplatformclientv2/models/create_queue_media_association_request.rb +3 -3
  881. data/lib/purecloudplatformclientv2/models/create_queue_request.rb +3 -3
  882. data/lib/purecloudplatformclientv2/models/create_secure_session.rb +3 -3
  883. data/lib/purecloudplatformclientv2/models/create_service_goal_group_request.rb +3 -3
  884. data/lib/purecloudplatformclientv2/models/create_share_request.rb +3 -3
  885. data/lib/purecloudplatformclientv2/models/create_share_request_member.rb +3 -3
  886. data/lib/purecloudplatformclientv2/models/create_share_response.rb +3 -3
  887. data/lib/purecloudplatformclientv2/models/create_user.rb +3 -3
  888. data/lib/purecloudplatformclientv2/models/create_web_chat_request.rb +3 -3
  889. data/lib/purecloudplatformclientv2/models/create_work_plan.rb +3 -3
  890. data/lib/purecloudplatformclientv2/models/create_work_plan_activity.rb +3 -3
  891. data/lib/purecloudplatformclientv2/models/create_work_plan_shift.rb +3 -3
  892. data/lib/purecloudplatformclientv2/models/credential.rb +3 -3
  893. data/lib/purecloudplatformclientv2/models/credential_info.rb +3 -3
  894. data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +16 -16
  895. data/lib/purecloudplatformclientv2/models/credential_specification.rb +3 -3
  896. data/lib/purecloudplatformclientv2/models/credential_type.rb +3 -3
  897. data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +16 -16
  898. data/lib/purecloudplatformclientv2/models/criteria.rb +311 -0
  899. data/lib/purecloudplatformclientv2/models/current_user_schedule_request_body.rb +33 -7
  900. data/lib/purecloudplatformclientv2/models/cursors.rb +226 -0
  901. data/lib/purecloudplatformclientv2/models/custom_event_attribute.rb +228 -0
  902. data/lib/purecloudplatformclientv2/models/customer_interaction_center.rb +3 -3
  903. data/lib/purecloudplatformclientv2/models/data_action_condition_predicate.rb +3 -3
  904. data/lib/purecloudplatformclientv2/models/data_schema.rb +3 -3
  905. data/lib/purecloudplatformclientv2/models/data_table.rb +3 -3
  906. data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +16 -16
  907. data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +16 -16
  908. data/lib/purecloudplatformclientv2/models/date_range.rb +3 -3
  909. data/lib/purecloudplatformclientv2/models/default_greeting_list.rb +3 -3
  910. data/lib/purecloudplatformclientv2/models/deletable_user_reference.rb +3 -3
  911. data/lib/purecloudplatformclientv2/models/delete_retention.rb +3 -3
  912. data/lib/purecloudplatformclientv2/models/dependency.rb +3 -3
  913. data/lib/purecloudplatformclientv2/models/dependency_object.rb +3 -3
  914. data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +16 -16
  915. data/lib/purecloudplatformclientv2/models/dependency_status.rb +3 -3
  916. data/lib/purecloudplatformclientv2/models/dependency_type.rb +3 -3
  917. data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +16 -16
  918. data/lib/purecloudplatformclientv2/models/destination.rb +3 -3
  919. data/lib/purecloudplatformclientv2/models/detail.rb +3 -3
  920. data/lib/purecloudplatformclientv2/models/device.rb +418 -0
  921. data/lib/purecloudplatformclientv2/models/dialer_action.rb +3 -3
  922. data/lib/purecloudplatformclientv2/models/dialer_attempt_limits_config_change_attempt_limits.rb +3 -3
  923. data/lib/purecloudplatformclientv2/models/dialer_attempt_limits_config_change_recall_entry.rb +3 -3
  924. data/lib/purecloudplatformclientv2/models/dialer_audit_request.rb +3 -3
  925. data/lib/purecloudplatformclientv2/models/dialer_callabletimeset_config_change_callable_time.rb +3 -3
  926. data/lib/purecloudplatformclientv2/models/dialer_callabletimeset_config_change_callable_time_set.rb +3 -3
  927. data/lib/purecloudplatformclientv2/models/dialer_callabletimeset_config_change_time_slot.rb +3 -3
  928. data/lib/purecloudplatformclientv2/models/dialer_campaign_config_change_campaign.rb +3 -3
  929. data/lib/purecloudplatformclientv2/models/dialer_campaign_config_change_contact_sort.rb +3 -3
  930. data/lib/purecloudplatformclientv2/models/dialer_campaign_config_change_phone_column.rb +3 -3
  931. data/lib/purecloudplatformclientv2/models/dialer_campaign_config_change_rest_error_detail.rb +3 -3
  932. data/lib/purecloudplatformclientv2/models/dialer_campaign_config_change_uri_reference.rb +3 -3
  933. data/lib/purecloudplatformclientv2/models/dialer_campaign_progress_event_campaign_progress.rb +3 -3
  934. data/lib/purecloudplatformclientv2/models/dialer_campaign_progress_event_uri_reference.rb +3 -3
  935. data/lib/purecloudplatformclientv2/models/dialer_campaign_rule_config_change_campaign_rule.rb +3 -3
  936. data/lib/purecloudplatformclientv2/models/dialer_campaign_rule_config_change_campaign_rule_action.rb +3 -3
  937. data/lib/purecloudplatformclientv2/models/dialer_campaign_rule_config_change_campaign_rule_action_entities.rb +3 -3
  938. data/lib/purecloudplatformclientv2/models/dialer_campaign_rule_config_change_campaign_rule_condition.rb +3 -3
  939. data/lib/purecloudplatformclientv2/models/dialer_campaign_rule_config_change_campaign_rule_entities.rb +3 -3
  940. data/lib/purecloudplatformclientv2/models/dialer_campaign_rule_config_change_uri_reference.rb +3 -3
  941. data/lib/purecloudplatformclientv2/models/dialer_campaign_schedule_config_change_campaign_schedule.rb +3 -3
  942. data/lib/purecloudplatformclientv2/models/dialer_campaign_schedule_config_change_schedule_interval.rb +3 -3
  943. data/lib/purecloudplatformclientv2/models/dialer_campaign_schedule_config_change_uri_reference.rb +3 -3
  944. data/lib/purecloudplatformclientv2/models/dialer_contact.rb +3 -3
  945. data/lib/purecloudplatformclientv2/models/dialer_contact_id.rb +3 -3
  946. data/lib/purecloudplatformclientv2/models/dialer_contactlist_config_change_contact_list.rb +3 -3
  947. data/lib/purecloudplatformclientv2/models/dialer_contactlist_config_change_contact_phone_number_column.rb +3 -3
  948. data/lib/purecloudplatformclientv2/models/dialer_contactlist_config_change_import_status.rb +3 -3
  949. data/lib/purecloudplatformclientv2/models/dialer_contactlist_config_change_uri_reference.rb +3 -3
  950. data/lib/purecloudplatformclientv2/models/dialer_contactlistfilter_config_change_contact_list_filter.rb +3 -3
  951. data/lib/purecloudplatformclientv2/models/dialer_contactlistfilter_config_change_filter_clause.rb +3 -3
  952. data/lib/purecloudplatformclientv2/models/dialer_contactlistfilter_config_change_filter_predicate.rb +3 -3
  953. data/lib/purecloudplatformclientv2/models/dialer_contactlistfilter_config_change_range.rb +3 -3
  954. data/lib/purecloudplatformclientv2/models/dialer_contactlistfilter_config_change_uri_reference.rb +3 -3
  955. data/lib/purecloudplatformclientv2/models/dialer_dnclist_config_change_dnc_list.rb +3 -3
  956. data/lib/purecloudplatformclientv2/models/dialer_dnclist_config_change_import_status.rb +3 -3
  957. data/lib/purecloudplatformclientv2/models/dialer_dnclist_config_change_uri_reference.rb +3 -3
  958. data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +16 -16
  959. data/lib/purecloudplatformclientv2/models/dialer_outbound_settings_config_change_outbound_settings.rb +3 -3
  960. data/lib/purecloudplatformclientv2/models/dialer_preview.rb +3 -3
  961. data/lib/purecloudplatformclientv2/models/dialer_responseset_config_change_reaction.rb +3 -3
  962. data/lib/purecloudplatformclientv2/models/dialer_responseset_config_change_response_set.rb +3 -3
  963. data/lib/purecloudplatformclientv2/models/dialer_rule.rb +3 -3
  964. data/lib/purecloudplatformclientv2/models/dialer_ruleset_config_change_action.rb +3 -3
  965. data/lib/purecloudplatformclientv2/models/dialer_ruleset_config_change_condition.rb +3 -3
  966. data/lib/purecloudplatformclientv2/models/dialer_ruleset_config_change_contact_column_to_data_action_field_mapping.rb +3 -3
  967. data/lib/purecloudplatformclientv2/models/dialer_ruleset_config_change_data_action_condition_predicate.rb +3 -3
  968. data/lib/purecloudplatformclientv2/models/dialer_ruleset_config_change_rule.rb +3 -3
  969. data/lib/purecloudplatformclientv2/models/dialer_ruleset_config_change_rule_set.rb +3 -3
  970. data/lib/purecloudplatformclientv2/models/dialer_ruleset_config_change_uri_reference.rb +3 -3
  971. data/lib/purecloudplatformclientv2/models/dialer_sequence_config_change_campaign_sequence.rb +3 -3
  972. data/lib/purecloudplatformclientv2/models/dialer_sequence_config_change_uri_reference.rb +3 -3
  973. data/lib/purecloudplatformclientv2/models/dialer_sequence_schedule_config_change_schedule_interval.rb +3 -3
  974. data/lib/purecloudplatformclientv2/models/dialer_sequence_schedule_config_change_sequence_schedule.rb +3 -3
  975. data/lib/purecloudplatformclientv2/models/dialer_sequence_schedule_config_change_uri_reference.rb +3 -3
  976. data/lib/purecloudplatformclientv2/models/dialer_wrapupcodemapping_config_change_wrap_up_code_mapping.rb +3 -3
  977. data/lib/purecloudplatformclientv2/models/did.rb +3 -3
  978. data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +16 -16
  979. data/lib/purecloudplatformclientv2/models/did_pool.rb +3 -3
  980. data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +16 -16
  981. data/lib/purecloudplatformclientv2/models/digit_length.rb +3 -3
  982. data/lib/purecloudplatformclientv2/models/digits.rb +3 -3
  983. data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +16 -16
  984. data/lib/purecloudplatformclientv2/models/disconnect_reason.rb +3 -3
  985. data/lib/purecloudplatformclientv2/models/division.rb +3 -3
  986. data/lib/purecloudplatformclientv2/models/dnc_list.rb +3 -3
  987. data/lib/purecloudplatformclientv2/models/dnc_list_create.rb +3 -3
  988. data/lib/purecloudplatformclientv2/models/dnc_list_division_view.rb +3 -3
  989. data/lib/purecloudplatformclientv2/models/dnc_list_division_view_listing.rb +16 -16
  990. data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +16 -16
  991. data/lib/purecloudplatformclientv2/models/dnclist_download_ready_export_uri.rb +3 -3
  992. data/lib/purecloudplatformclientv2/models/dnclist_import_status_import_status.rb +3 -3
  993. data/lib/purecloudplatformclientv2/models/document.rb +15 -15
  994. data/lib/purecloudplatformclientv2/models/document_attribute.rb +3 -3
  995. data/lib/purecloudplatformclientv2/models/document_audit.rb +3 -3
  996. data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +16 -16
  997. data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +16 -16
  998. data/lib/purecloudplatformclientv2/models/document_thumbnail.rb +3 -3
  999. data/lib/purecloudplatformclientv2/models/document_update.rb +3 -3
  1000. data/lib/purecloudplatformclientv2/models/document_upload.rb +3 -3
  1001. data/lib/purecloudplatformclientv2/models/documentation_result.rb +3 -3
  1002. data/lib/purecloudplatformclientv2/models/documentation_search_criteria.rb +3 -3
  1003. data/lib/purecloudplatformclientv2/models/documentation_search_request.rb +3 -3
  1004. data/lib/purecloudplatformclientv2/models/documentation_search_response.rb +3 -3
  1005. data/lib/purecloudplatformclientv2/models/domain_capabilities.rb +3 -3
  1006. data/lib/purecloudplatformclientv2/models/domain_certificate_authority.rb +3 -3
  1007. data/lib/purecloudplatformclientv2/models/domain_edge_software_update_dto.rb +3 -3
  1008. data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto.rb +3 -3
  1009. data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +16 -16
  1010. data/lib/purecloudplatformclientv2/models/domain_entity.rb +3 -3
  1011. data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +16 -16
  1012. data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +16 -16
  1013. data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +16 -16
  1014. data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +16 -16
  1015. data/lib/purecloudplatformclientv2/models/domain_logical_interface.rb +3 -3
  1016. data/lib/purecloudplatformclientv2/models/domain_network_address.rb +3 -3
  1017. data/lib/purecloudplatformclientv2/models/domain_network_command_response.rb +3 -3
  1018. data/lib/purecloudplatformclientv2/models/domain_network_route.rb +3 -3
  1019. data/lib/purecloudplatformclientv2/models/domain_org_role_difference.rb +3 -3
  1020. data/lib/purecloudplatformclientv2/models/domain_organization_product.rb +3 -3
  1021. data/lib/purecloudplatformclientv2/models/domain_organization_role.rb +3 -3
  1022. data/lib/purecloudplatformclientv2/models/domain_organization_role_create.rb +3 -3
  1023. data/lib/purecloudplatformclientv2/models/domain_organization_role_update.rb +3 -3
  1024. data/lib/purecloudplatformclientv2/models/domain_permission.rb +3 -3
  1025. data/lib/purecloudplatformclientv2/models/domain_permission_collection.rb +3 -3
  1026. data/lib/purecloudplatformclientv2/models/domain_permission_policy.rb +3 -3
  1027. data/lib/purecloudplatformclientv2/models/domain_physical_capabilities.rb +3 -3
  1028. data/lib/purecloudplatformclientv2/models/domain_physical_interface.rb +3 -3
  1029. data/lib/purecloudplatformclientv2/models/domain_resource_condition_node.rb +3 -3
  1030. data/lib/purecloudplatformclientv2/models/domain_resource_condition_value.rb +3 -3
  1031. data/lib/purecloudplatformclientv2/models/domain_role.rb +3 -3
  1032. data/lib/purecloudplatformclientv2/models/domain_schema_reference.rb +3 -3
  1033. data/lib/purecloudplatformclientv2/models/download_response.rb +3 -3
  1034. data/lib/purecloudplatformclientv2/models/draft_validation_result.rb +3 -3
  1035. data/lib/purecloudplatformclientv2/models/duration_condition.rb +3 -3
  1036. data/lib/purecloudplatformclientv2/models/edge.rb +3 -3
  1037. data/lib/purecloudplatformclientv2/models/edge_auto_update_config.rb +3 -3
  1038. data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +16 -16
  1039. data/lib/purecloudplatformclientv2/models/edge_group.rb +3 -3
  1040. data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +16 -16
  1041. data/lib/purecloudplatformclientv2/models/edge_interface.rb +3 -3
  1042. data/lib/purecloudplatformclientv2/models/edge_line.rb +3 -3
  1043. data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +16 -16
  1044. data/lib/purecloudplatformclientv2/models/edge_logs_job.rb +3 -3
  1045. data/lib/purecloudplatformclientv2/models/edge_logs_job_file.rb +3 -3
  1046. data/lib/purecloudplatformclientv2/models/edge_logs_job_request.rb +3 -3
  1047. data/lib/purecloudplatformclientv2/models/edge_logs_job_response.rb +3 -3
  1048. data/lib/purecloudplatformclientv2/models/edge_logs_job_upload_request.rb +3 -3
  1049. data/lib/purecloudplatformclientv2/models/edge_metrics.rb +3 -3
  1050. data/lib/purecloudplatformclientv2/models/edge_metrics_disk.rb +3 -3
  1051. data/lib/purecloudplatformclientv2/models/edge_metrics_memory.rb +3 -3
  1052. data/lib/purecloudplatformclientv2/models/edge_metrics_network.rb +3 -3
  1053. data/lib/purecloudplatformclientv2/models/edge_metrics_processor.rb +3 -3
  1054. data/lib/purecloudplatformclientv2/models/edge_metrics_subsystem.rb +3 -3
  1055. data/lib/purecloudplatformclientv2/models/edge_reboot_parameters.rb +3 -3
  1056. data/lib/purecloudplatformclientv2/models/edge_service_state_request.rb +3 -3
  1057. data/lib/purecloudplatformclientv2/models/edge_trunk_base.rb +3 -3
  1058. data/lib/purecloudplatformclientv2/models/edge_version_information.rb +3 -3
  1059. data/lib/purecloudplatformclientv2/models/edge_version_report.rb +3 -3
  1060. data/lib/purecloudplatformclientv2/models/effective_configuration.rb +3 -3
  1061. data/lib/purecloudplatformclientv2/models/email.rb +30 -4
  1062. data/lib/purecloudplatformclientv2/models/email_address.rb +3 -3
  1063. data/lib/purecloudplatformclientv2/models/email_attachment.rb +3 -3
  1064. data/lib/purecloudplatformclientv2/models/email_conversation.rb +3 -3
  1065. data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +16 -16
  1066. data/lib/purecloudplatformclientv2/models/email_media_participant.rb +3 -3
  1067. data/lib/purecloudplatformclientv2/models/email_media_policy.rb +3 -3
  1068. data/lib/purecloudplatformclientv2/models/email_media_policy_conditions.rb +3 -3
  1069. data/lib/purecloudplatformclientv2/models/email_message.rb +3 -3
  1070. data/lib/purecloudplatformclientv2/models/email_message_listing.rb +16 -16
  1071. data/lib/purecloudplatformclientv2/models/email_setup.rb +3 -3
  1072. data/lib/purecloudplatformclientv2/models/emergency_call_flow.rb +3 -3
  1073. data/lib/purecloudplatformclientv2/models/emergency_group.rb +3 -3
  1074. data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +16 -16
  1075. data/lib/purecloudplatformclientv2/models/employer_info.rb +3 -3
  1076. data/lib/purecloudplatformclientv2/models/empty.rb +3 -3
  1077. data/lib/purecloudplatformclientv2/models/encryption_key.rb +3 -3
  1078. data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +16 -16
  1079. data/lib/purecloudplatformclientv2/models/endpoint.rb +3 -3
  1080. data/lib/purecloudplatformclientv2/models/entity.rb +3 -3
  1081. data/lib/purecloudplatformclientv2/models/entity_type_criteria.rb +351 -0
  1082. data/lib/purecloudplatformclientv2/models/entry.rb +3 -3
  1083. data/lib/purecloudplatformclientv2/models/error_body.rb +3 -3
  1084. data/lib/purecloudplatformclientv2/models/error_details.rb +3 -3
  1085. data/lib/purecloudplatformclientv2/models/estimated_wait_time_predictions.rb +3 -3
  1086. data/lib/purecloudplatformclientv2/models/evaluation.rb +3 -3
  1087. data/lib/purecloudplatformclientv2/models/evaluation_assignment.rb +3 -3
  1088. data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +16 -16
  1089. data/lib/purecloudplatformclientv2/models/evaluation_form.rb +3 -3
  1090. data/lib/purecloudplatformclientv2/models/evaluation_form_and_scoring_set.rb +3 -3
  1091. data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +16 -16
  1092. data/lib/purecloudplatformclientv2/models/evaluation_question.rb +3 -3
  1093. data/lib/purecloudplatformclientv2/models/evaluation_question_group.rb +3 -3
  1094. data/lib/purecloudplatformclientv2/models/evaluation_question_group_score.rb +3 -3
  1095. data/lib/purecloudplatformclientv2/models/evaluation_question_score.rb +3 -3
  1096. data/lib/purecloudplatformclientv2/models/evaluation_scoring_set.rb +3 -3
  1097. data/lib/purecloudplatformclientv2/models/evaluator_activity.rb +3 -3
  1098. data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +16 -16
  1099. data/lib/purecloudplatformclientv2/models/event.rb +503 -0
  1100. data/lib/purecloudplatformclientv2/models/event_action.rb +339 -0
  1101. data/lib/purecloudplatformclientv2/models/event_condition.rb +280 -0
  1102. data/lib/purecloudplatformclientv2/models/event_entity.rb +3 -3
  1103. data/lib/purecloudplatformclientv2/models/event_listing.rb +278 -0
  1104. data/lib/purecloudplatformclientv2/models/event_log.rb +3 -3
  1105. data/lib/purecloudplatformclientv2/models/event_message.rb +3 -3
  1106. data/lib/purecloudplatformclientv2/models/expansion_criterium.rb +3 -3
  1107. data/lib/purecloudplatformclientv2/models/export_script_request.rb +3 -3
  1108. data/lib/purecloudplatformclientv2/models/export_script_response.rb +3 -3
  1109. data/lib/purecloudplatformclientv2/models/export_uri.rb +3 -3
  1110. data/lib/purecloudplatformclientv2/models/extension.rb +3 -3
  1111. data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +16 -16
  1112. data/lib/purecloudplatformclientv2/models/extension_pool.rb +3 -3
  1113. data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +16 -16
  1114. data/lib/purecloudplatformclientv2/models/external_contact.rb +3 -3
  1115. data/lib/purecloudplatformclientv2/models/external_data_source.rb +3 -3
  1116. data/lib/purecloudplatformclientv2/models/external_organization.rb +3 -3
  1117. data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +16 -16
  1118. data/lib/purecloudplatformclientv2/models/facebook_id.rb +3 -3
  1119. data/lib/purecloudplatformclientv2/models/facebook_integration.rb +3 -3
  1120. data/lib/purecloudplatformclientv2/models/facebook_integration_entity_listing.rb +16 -16
  1121. data/lib/purecloudplatformclientv2/models/facebook_integration_request.rb +3 -3
  1122. data/lib/purecloudplatformclientv2/models/facebook_scoped_id.rb +3 -3
  1123. data/lib/purecloudplatformclientv2/models/facet.rb +3 -3
  1124. data/lib/purecloudplatformclientv2/models/facet_entry.rb +3 -3
  1125. data/lib/purecloudplatformclientv2/models/facet_info.rb +3 -3
  1126. data/lib/purecloudplatformclientv2/models/facet_key_attribute.rb +3 -3
  1127. data/lib/purecloudplatformclientv2/models/facet_statistics.rb +3 -3
  1128. data/lib/purecloudplatformclientv2/models/facet_term.rb +3 -3
  1129. data/lib/purecloudplatformclientv2/models/failed_object.rb +3 -3
  1130. data/lib/purecloudplatformclientv2/models/fax_document.rb +15 -15
  1131. data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +16 -16
  1132. data/lib/purecloudplatformclientv2/models/fax_send_request.rb +3 -3
  1133. data/lib/purecloudplatformclientv2/models/fax_send_response.rb +3 -3
  1134. data/lib/purecloudplatformclientv2/models/fax_status.rb +3 -3
  1135. data/lib/purecloudplatformclientv2/models/fax_summary.rb +3 -3
  1136. data/lib/purecloudplatformclientv2/models/fax_topic_fax_data_v2.rb +3 -3
  1137. data/lib/purecloudplatformclientv2/models/fax_topic_lock_data.rb +3 -3
  1138. data/lib/purecloudplatformclientv2/models/fax_topic_user_data.rb +3 -3
  1139. data/lib/purecloudplatformclientv2/models/fax_topic_workspace_data.rb +3 -3
  1140. data/lib/purecloudplatformclientv2/models/feature_state.rb +3 -3
  1141. data/lib/purecloudplatformclientv2/models/field_config.rb +3 -3
  1142. data/lib/purecloudplatformclientv2/models/field_configs.rb +3 -3
  1143. data/lib/purecloudplatformclientv2/models/field_list.rb +3 -3
  1144. data/lib/purecloudplatformclientv2/models/filter.rb +3 -3
  1145. data/lib/purecloudplatformclientv2/models/filter_preview_response.rb +3 -3
  1146. data/lib/purecloudplatformclientv2/models/flow.rb +4 -4
  1147. data/lib/purecloudplatformclientv2/models/flow_division_view.rb +4 -4
  1148. data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +16 -16
  1149. data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +16 -16
  1150. data/lib/purecloudplatformclientv2/models/flow_version.rb +3 -3
  1151. data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +16 -16
  1152. data/lib/purecloudplatformclientv2/models/forecast_generation_result.rb +3 -3
  1153. data/lib/purecloudplatformclientv2/models/forecast_generation_route_group_result.rb +3 -3
  1154. data/lib/purecloudplatformclientv2/models/forecast_result_response.rb +3 -3
  1155. data/lib/purecloudplatformclientv2/models/forecast_source_day_pointer.rb +3 -3
  1156. data/lib/purecloudplatformclientv2/models/forecast_time_series_result.rb +3 -3
  1157. data/lib/purecloudplatformclientv2/models/free_seating_configuration.rb +3 -3
  1158. data/lib/purecloudplatformclientv2/models/g_suite.rb +3 -3
  1159. data/lib/purecloudplatformclientv2/models/gdpr_request.rb +3 -3
  1160. data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +16 -16
  1161. data/lib/purecloudplatformclientv2/models/gdpr_subject.rb +3 -3
  1162. data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +16 -16
  1163. data/lib/purecloudplatformclientv2/models/generate_short_term_forecast_request.rb +3 -3
  1164. data/lib/purecloudplatformclientv2/models/generate_short_term_forecast_response.rb +3 -3
  1165. data/lib/purecloudplatformclientv2/models/generate_week_schedule_request.rb +3 -3
  1166. data/lib/purecloudplatformclientv2/models/generate_week_schedule_response.rb +3 -3
  1167. data/lib/purecloudplatformclientv2/models/generic_action_event.rb +285 -0
  1168. data/lib/purecloudplatformclientv2/models/generic_event_action.rb +365 -0
  1169. data/lib/purecloudplatformclientv2/models/geolocation.rb +3 -3
  1170. data/lib/purecloudplatformclientv2/models/geolocation_event_geolocation.rb +3 -3
  1171. data/lib/purecloudplatformclientv2/models/geolocation_settings.rb +3 -3
  1172. data/lib/purecloudplatformclientv2/models/gkn_documentation_result.rb +3 -3
  1173. data/lib/purecloudplatformclientv2/models/gkn_documentation_search_criteria.rb +3 -3
  1174. data/lib/purecloudplatformclientv2/models/gkn_documentation_search_request.rb +3 -3
  1175. data/lib/purecloudplatformclientv2/models/gkn_documentation_search_response.rb +3 -3
  1176. data/lib/purecloudplatformclientv2/models/greeting.rb +3 -3
  1177. data/lib/purecloudplatformclientv2/models/greeting_audio_file.rb +3 -3
  1178. data/lib/purecloudplatformclientv2/models/greeting_listing.rb +16 -16
  1179. data/lib/purecloudplatformclientv2/models/greeting_media_info.rb +3 -3
  1180. data/lib/purecloudplatformclientv2/models/greeting_owner.rb +3 -3
  1181. data/lib/purecloudplatformclientv2/models/group.rb +3 -3
  1182. data/lib/purecloudplatformclientv2/models/group_contact.rb +3 -3
  1183. data/lib/purecloudplatformclientv2/models/group_create.rb +3 -3
  1184. data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +16 -16
  1185. data/lib/purecloudplatformclientv2/models/group_greeting_event_greeting.rb +3 -3
  1186. data/lib/purecloudplatformclientv2/models/group_greeting_event_greeting_audio_file.rb +3 -3
  1187. data/lib/purecloudplatformclientv2/models/group_greeting_event_greeting_owner.rb +3 -3
  1188. data/lib/purecloudplatformclientv2/models/group_members_update.rb +3 -3
  1189. data/lib/purecloudplatformclientv2/models/group_profile.rb +3 -3
  1190. data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +16 -16
  1191. data/lib/purecloudplatformclientv2/models/group_search_criteria.rb +3 -3
  1192. data/lib/purecloudplatformclientv2/models/group_search_request.rb +3 -3
  1193. data/lib/purecloudplatformclientv2/models/group_update.rb +3 -3
  1194. data/lib/purecloudplatformclientv2/models/groups_search_response.rb +3 -3
  1195. data/lib/purecloudplatformclientv2/models/headcount_forecast.rb +3 -3
  1196. data/lib/purecloudplatformclientv2/models/headcount_interval.rb +3 -3
  1197. data/lib/purecloudplatformclientv2/models/help_link.rb +3 -3
  1198. data/lib/purecloudplatformclientv2/models/history_entry.rb +343 -0
  1199. data/lib/purecloudplatformclientv2/models/history_listing.rb +134 -7
  1200. data/lib/purecloudplatformclientv2/models/identity_now.rb +3 -3
  1201. data/lib/purecloudplatformclientv2/models/ignored_activity_categories.rb +3 -3
  1202. data/lib/purecloudplatformclientv2/models/import_script_status_response.rb +3 -3
  1203. data/lib/purecloudplatformclientv2/models/import_short_term_forecast_request.rb +3 -3
  1204. data/lib/purecloudplatformclientv2/models/import_status.rb +3 -3
  1205. data/lib/purecloudplatformclientv2/models/import_week_schedule_request.rb +3 -3
  1206. data/lib/purecloudplatformclientv2/models/inbound_domain.rb +3 -3
  1207. data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +16 -16
  1208. data/lib/purecloudplatformclientv2/models/inbound_message_request.rb +3 -3
  1209. data/lib/purecloudplatformclientv2/models/inbound_route.rb +58 -4
  1210. data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +16 -16
  1211. data/lib/purecloudplatformclientv2/models/initiate_screen_recording.rb +3 -3
  1212. data/lib/purecloudplatformclientv2/models/integration.rb +3 -3
  1213. data/lib/purecloudplatformclientv2/models/integration_configuration.rb +3 -3
  1214. data/lib/purecloudplatformclientv2/models/integration_configuration_info.rb +3 -3
  1215. data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +16 -16
  1216. data/lib/purecloudplatformclientv2/models/integration_event.rb +3 -3
  1217. data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +16 -16
  1218. data/lib/purecloudplatformclientv2/models/integration_status_info.rb +3 -3
  1219. data/lib/purecloudplatformclientv2/models/integration_type.rb +3 -3
  1220. data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +16 -16
  1221. data/lib/purecloudplatformclientv2/models/interaction_stats_alert.rb +3 -3
  1222. data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +16 -16
  1223. data/lib/purecloudplatformclientv2/models/interaction_stats_rule.rb +3 -3
  1224. data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +16 -16
  1225. data/lib/purecloudplatformclientv2/models/intraday_data_group.rb +3 -3
  1226. data/lib/purecloudplatformclientv2/models/intraday_forecast_data.rb +3 -3
  1227. data/lib/purecloudplatformclientv2/models/intraday_historical_agent_data.rb +3 -3
  1228. data/lib/purecloudplatformclientv2/models/intraday_historical_queue_data.rb +3 -3
  1229. data/lib/purecloudplatformclientv2/models/intraday_metric.rb +3 -3
  1230. data/lib/purecloudplatformclientv2/models/intraday_performance_prediction_agent_data.rb +3 -3
  1231. data/lib/purecloudplatformclientv2/models/intraday_performance_prediction_queue_data.rb +3 -3
  1232. data/lib/purecloudplatformclientv2/models/intraday_query_data_command.rb +3 -3
  1233. data/lib/purecloudplatformclientv2/models/intraday_queue.rb +3 -3
  1234. data/lib/purecloudplatformclientv2/models/intraday_response.rb +3 -3
  1235. data/lib/purecloudplatformclientv2/models/intraday_schedule_data.rb +3 -3
  1236. data/lib/purecloudplatformclientv2/models/ivr.rb +3 -3
  1237. data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +16 -16
  1238. data/lib/purecloudplatformclientv2/models/journey.rb +209 -0
  1239. data/lib/purecloudplatformclientv2/models/journey_action.rb +8 -3
  1240. data/lib/purecloudplatformclientv2/models/journey_action_map.rb +3 -3
  1241. data/lib/purecloudplatformclientv2/models/journey_campaign.rb +358 -0
  1242. data/lib/purecloudplatformclientv2/models/journey_context.rb +8 -3
  1243. data/lib/purecloudplatformclientv2/models/journey_customer.rb +3 -3
  1244. data/lib/purecloudplatformclientv2/models/journey_customer_session.rb +3 -3
  1245. data/lib/purecloudplatformclientv2/models/journey_geolocation.rb +436 -0
  1246. data/lib/purecloudplatformclientv2/models/journey_page.rb +458 -0
  1247. data/lib/purecloudplatformclientv2/models/journey_pattern.rb +235 -0
  1248. data/lib/purecloudplatformclientv2/models/journey_segment.rb +518 -0
  1249. data/lib/purecloudplatformclientv2/models/journey_survey_question.rb +341 -0
  1250. data/lib/purecloudplatformclientv2/models/json_node_search_response.rb +3 -3
  1251. data/lib/purecloudplatformclientv2/models/json_schema_document.rb +3 -3
  1252. data/lib/purecloudplatformclientv2/models/key_rotation_schedule.rb +3 -3
  1253. data/lib/purecloudplatformclientv2/models/keyword.rb +3 -3
  1254. data/lib/purecloudplatformclientv2/models/keyword_set.rb +3 -3
  1255. data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +16 -16
  1256. data/lib/purecloudplatformclientv2/models/klaxon_heart_beat_alerts_topic_heart_beat_alert.rb +3 -3
  1257. data/lib/purecloudplatformclientv2/models/klaxon_heart_beat_alerts_topic_notification_user.rb +3 -3
  1258. data/lib/purecloudplatformclientv2/models/klaxon_heart_beat_rules_topic_heart_beat_rule.rb +3 -3
  1259. data/lib/purecloudplatformclientv2/models/klaxon_heart_beat_rules_topic_notification_user.rb +3 -3
  1260. data/lib/purecloudplatformclientv2/models/klaxon_interaction_stats_alerts_topic_interaction_stat_alert.rb +3 -3
  1261. data/lib/purecloudplatformclientv2/models/klaxon_interaction_stats_alerts_topic_notification_user.rb +3 -3
  1262. data/lib/purecloudplatformclientv2/models/klaxon_interaction_stats_rules_topic_interaction_stat_rule.rb +3 -3
  1263. data/lib/purecloudplatformclientv2/models/klaxon_interaction_stats_rules_topic_notification_user.rb +3 -3
  1264. data/lib/purecloudplatformclientv2/models/language.rb +3 -3
  1265. data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +16 -16
  1266. data/lib/purecloudplatformclientv2/models/language_reference.rb +3 -3
  1267. data/lib/purecloudplatformclientv2/models/library.rb +3 -3
  1268. data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +16 -16
  1269. data/lib/purecloudplatformclientv2/models/license_assignment_request.rb +3 -3
  1270. data/lib/purecloudplatformclientv2/models/license_batch_assignment_request.rb +3 -3
  1271. data/lib/purecloudplatformclientv2/models/license_definition.rb +3 -3
  1272. data/lib/purecloudplatformclientv2/models/license_org_toggle.rb +3 -3
  1273. data/lib/purecloudplatformclientv2/models/license_organization.rb +3 -3
  1274. data/lib/purecloudplatformclientv2/models/license_update_status.rb +3 -3
  1275. data/lib/purecloudplatformclientv2/models/license_user.rb +3 -3
  1276. data/lib/purecloudplatformclientv2/models/line.rb +3 -3
  1277. data/lib/purecloudplatformclientv2/models/line_base.rb +3 -3
  1278. data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +16 -16
  1279. data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +16 -16
  1280. data/lib/purecloudplatformclientv2/models/line_id.rb +3 -3
  1281. data/lib/purecloudplatformclientv2/models/line_integration.rb +3 -3
  1282. data/lib/purecloudplatformclientv2/models/line_integration_entity_listing.rb +16 -16
  1283. data/lib/purecloudplatformclientv2/models/line_integration_request.rb +32 -6
  1284. data/lib/purecloudplatformclientv2/models/line_status.rb +3 -3
  1285. data/lib/purecloudplatformclientv2/models/line_user_id.rb +3 -3
  1286. data/lib/purecloudplatformclientv2/models/list_wrapper_forecast_source_day_pointer.rb +3 -3
  1287. data/lib/purecloudplatformclientv2/models/list_wrapper_shift_start_variance.rb +3 -3
  1288. data/lib/purecloudplatformclientv2/models/list_wrapper_wfm_forecast_modification.rb +3 -3
  1289. data/lib/purecloudplatformclientv2/models/local_encryption_configuration.rb +3 -3
  1290. data/lib/purecloudplatformclientv2/models/local_encryption_configuration_listing.rb +3 -3
  1291. data/lib/purecloudplatformclientv2/models/local_encryption_key_request.rb +3 -3
  1292. data/lib/purecloudplatformclientv2/models/location.rb +3 -3
  1293. data/lib/purecloudplatformclientv2/models/location_address.rb +3 -3
  1294. data/lib/purecloudplatformclientv2/models/location_definition.rb +3 -3
  1295. data/lib/purecloudplatformclientv2/models/location_emergency_number.rb +3 -3
  1296. data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +16 -16
  1297. data/lib/purecloudplatformclientv2/models/location_search_criteria.rb +3 -3
  1298. data/lib/purecloudplatformclientv2/models/location_search_request.rb +3 -3
  1299. data/lib/purecloudplatformclientv2/models/location_update_definition.rb +3 -3
  1300. data/lib/purecloudplatformclientv2/models/locations_search_response.rb +3 -3
  1301. data/lib/purecloudplatformclientv2/models/lock_info.rb +3 -3
  1302. data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +16 -16
  1303. data/lib/purecloudplatformclientv2/models/management_unit.rb +3 -3
  1304. data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +16 -16
  1305. data/lib/purecloudplatformclientv2/models/management_unit_settings.rb +30 -4
  1306. data/lib/purecloudplatformclientv2/models/match_shift_trade_request.rb +264 -0
  1307. data/lib/purecloudplatformclientv2/models/match_shift_trade_response.rb +258 -0
  1308. data/lib/purecloudplatformclientv2/models/max_participants.rb +3 -3
  1309. data/lib/purecloudplatformclientv2/models/media_participant_request.rb +3 -3
  1310. data/lib/purecloudplatformclientv2/models/media_policies.rb +3 -3
  1311. data/lib/purecloudplatformclientv2/models/media_result.rb +3 -3
  1312. data/lib/purecloudplatformclientv2/models/media_setting.rb +3 -3
  1313. data/lib/purecloudplatformclientv2/models/media_summary.rb +3 -3
  1314. data/lib/purecloudplatformclientv2/models/media_summary_detail.rb +3 -3
  1315. data/lib/purecloudplatformclientv2/models/media_transcription.rb +5 -5
  1316. data/lib/purecloudplatformclientv2/models/member_entity.rb +3 -3
  1317. data/lib/purecloudplatformclientv2/models/message.rb +30 -4
  1318. data/lib/purecloudplatformclientv2/models/message_conversation.rb +3 -3
  1319. data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +16 -16
  1320. data/lib/purecloudplatformclientv2/models/message_data.rb +3 -3
  1321. data/lib/purecloudplatformclientv2/models/message_details.rb +3 -3
  1322. data/lib/purecloudplatformclientv2/models/message_info.rb +3 -3
  1323. data/lib/purecloudplatformclientv2/models/message_media.rb +3 -3
  1324. data/lib/purecloudplatformclientv2/models/message_media_attachment.rb +3 -3
  1325. data/lib/purecloudplatformclientv2/models/message_media_data.rb +3 -3
  1326. data/lib/purecloudplatformclientv2/models/message_media_participant.rb +3 -3
  1327. data/lib/purecloudplatformclientv2/models/message_media_policy.rb +3 -3
  1328. data/lib/purecloudplatformclientv2/models/message_media_policy_conditions.rb +3 -3
  1329. data/lib/purecloudplatformclientv2/models/message_sticker.rb +3 -3
  1330. data/lib/purecloudplatformclientv2/models/message_sticker_attachment.rb +3 -3
  1331. data/lib/purecloudplatformclientv2/models/messaging_sticker.rb +3 -3
  1332. data/lib/purecloudplatformclientv2/models/messaging_sticker_entity_listing.rb +16 -16
  1333. data/lib/purecloudplatformclientv2/models/meta_data.rb +3 -3
  1334. data/lib/purecloudplatformclientv2/models/metabase.rb +3 -3
  1335. data/lib/purecloudplatformclientv2/models/metered_evaluation_assignment.rb +3 -3
  1336. data/lib/purecloudplatformclientv2/models/modeling_processing_error.rb +242 -0
  1337. data/lib/purecloudplatformclientv2/models/modeling_status_response.rb +296 -0
  1338. data/lib/purecloudplatformclientv2/models/named_entity.rb +3 -3
  1339. data/lib/purecloudplatformclientv2/models/note.rb +3 -3
  1340. data/lib/purecloudplatformclientv2/models/note_listing.rb +16 -16
  1341. data/lib/purecloudplatformclientv2/models/notifications_response.rb +203 -0
  1342. data/lib/purecloudplatformclientv2/models/ntp_settings.rb +3 -3
  1343. data/lib/purecloudplatformclientv2/models/number.rb +3 -3
  1344. data/lib/purecloudplatformclientv2/models/number_plan.rb +3 -3
  1345. data/lib/purecloudplatformclientv2/models/numeric_range.rb +3 -3
  1346. data/lib/purecloudplatformclientv2/models/o_auth_client.rb +3 -3
  1347. data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +16 -16
  1348. data/lib/purecloudplatformclientv2/models/o_auth_client_listing.rb +3 -3
  1349. data/lib/purecloudplatformclientv2/models/o_auth_provider.rb +3 -3
  1350. data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +16 -16
  1351. data/lib/purecloudplatformclientv2/models/observation_data_container.rb +3 -3
  1352. data/lib/purecloudplatformclientv2/models/observation_metric_data.rb +61 -7
  1353. data/lib/purecloudplatformclientv2/models/observation_query.rb +35 -7
  1354. data/lib/purecloudplatformclientv2/models/observation_query_response.rb +3 -3
  1355. data/lib/purecloudplatformclientv2/models/observation_value.rb +561 -0
  1356. data/lib/purecloudplatformclientv2/models/okta.rb +3 -3
  1357. data/lib/purecloudplatformclientv2/models/one_login.rb +3 -3
  1358. data/lib/purecloudplatformclientv2/models/operation.rb +3 -3
  1359. data/lib/purecloudplatformclientv2/models/org_media_utilization.rb +3 -3
  1360. data/lib/purecloudplatformclientv2/models/org_o_auth_client.rb +3 -3
  1361. data/lib/purecloudplatformclientv2/models/org_user.rb +3 -3
  1362. data/lib/purecloudplatformclientv2/models/org_whitelist_settings.rb +3 -3
  1363. data/lib/purecloudplatformclientv2/models/organization.rb +3 -3
  1364. data/lib/purecloudplatformclientv2/models/organization_features.rb +3 -3
  1365. data/lib/purecloudplatformclientv2/models/organization_presence.rb +3 -3
  1366. data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +16 -16
  1367. data/lib/purecloudplatformclientv2/models/organization_product_entity_listing.rb +3 -3
  1368. data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +16 -16
  1369. data/lib/purecloudplatformclientv2/models/orphan_recording.rb +3 -3
  1370. data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +16 -16
  1371. data/lib/purecloudplatformclientv2/models/orphan_update_request.rb +3 -3
  1372. data/lib/purecloudplatformclientv2/models/out_of_office.rb +3 -3
  1373. data/lib/purecloudplatformclientv2/models/out_of_office_event_out_of_office.rb +3 -3
  1374. data/lib/purecloudplatformclientv2/models/out_of_office_event_user.rb +3 -3
  1375. data/lib/purecloudplatformclientv2/models/outbound_route.rb +3 -3
  1376. data/lib/purecloudplatformclientv2/models/outbound_route_base.rb +3 -3
  1377. data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +16 -16
  1378. data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +16 -16
  1379. data/lib/purecloudplatformclientv2/models/outbound_settings.rb +3 -3
  1380. data/lib/purecloudplatformclientv2/models/outcome.rb +492 -0
  1381. data/lib/purecloudplatformclientv2/models/outcome_achieved_event.rb +441 -0
  1382. data/lib/purecloudplatformclientv2/models/outcome_probability_condition.rb +264 -0
  1383. data/lib/purecloudplatformclientv2/models/page.rb +3 -3
  1384. data/lib/purecloudplatformclientv2/models/paging_spec.rb +3 -3
  1385. data/lib/purecloudplatformclientv2/models/parameter.rb +3 -3
  1386. data/lib/purecloudplatformclientv2/models/parsed_certificate.rb +3 -3
  1387. data/lib/purecloudplatformclientv2/models/partial_upload_response.rb +3 -3
  1388. data/lib/purecloudplatformclientv2/models/participant.rb +3 -3
  1389. data/lib/purecloudplatformclientv2/models/participant_attributes.rb +3 -3
  1390. data/lib/purecloudplatformclientv2/models/participant_basic.rb +3 -3
  1391. data/lib/purecloudplatformclientv2/models/patch_user.rb +3 -3
  1392. data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +16 -16
  1393. data/lib/purecloudplatformclientv2/models/permissions.rb +3 -3
  1394. data/lib/purecloudplatformclientv2/models/phone.rb +3 -3
  1395. data/lib/purecloudplatformclientv2/models/phone_base.rb +3 -3
  1396. data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +16 -16
  1397. data/lib/purecloudplatformclientv2/models/phone_capabilities.rb +3 -3
  1398. data/lib/purecloudplatformclientv2/models/phone_column.rb +3 -3
  1399. data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +16 -16
  1400. data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +16 -16
  1401. data/lib/purecloudplatformclientv2/models/phone_number.rb +3 -3
  1402. data/lib/purecloudplatformclientv2/models/phone_number_column.rb +3 -3
  1403. data/lib/purecloudplatformclientv2/models/phone_number_status.rb +3 -3
  1404. data/lib/purecloudplatformclientv2/models/phone_status.rb +3 -3
  1405. data/lib/purecloudplatformclientv2/models/phones_reboot.rb +3 -3
  1406. data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +16 -16
  1407. data/lib/purecloudplatformclientv2/models/pin_configuration.rb +3 -3
  1408. data/lib/purecloudplatformclientv2/models/ping_identity.rb +3 -3
  1409. data/lib/purecloudplatformclientv2/models/policy.rb +3 -3
  1410. data/lib/purecloudplatformclientv2/models/policy_actions.rb +3 -3
  1411. data/lib/purecloudplatformclientv2/models/policy_conditions.rb +3 -3
  1412. data/lib/purecloudplatformclientv2/models/policy_create.rb +3 -3
  1413. data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +16 -16
  1414. data/lib/purecloudplatformclientv2/models/policy_error_message.rb +3 -3
  1415. data/lib/purecloudplatformclientv2/models/policy_errors.rb +3 -3
  1416. data/lib/purecloudplatformclientv2/models/post_action_input.rb +3 -3
  1417. data/lib/purecloudplatformclientv2/models/post_input_contract.rb +3 -3
  1418. data/lib/purecloudplatformclientv2/models/post_output_contract.rb +3 -3
  1419. data/lib/purecloudplatformclientv2/models/prediction_results.rb +3 -3
  1420. data/lib/purecloudplatformclientv2/models/presence_definition.rb +3 -3
  1421. data/lib/purecloudplatformclientv2/models/presence_event_organization_presence.rb +3 -3
  1422. data/lib/purecloudplatformclientv2/models/presence_event_user_presence.rb +3 -3
  1423. data/lib/purecloudplatformclientv2/models/presence_query_response.rb +3 -3
  1424. data/lib/purecloudplatformclientv2/models/prompt.rb +3 -3
  1425. data/lib/purecloudplatformclientv2/models/prompt_asset.rb +3 -3
  1426. data/lib/purecloudplatformclientv2/models/prompt_asset_create.rb +3 -3
  1427. data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +16 -16
  1428. data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +16 -16
  1429. data/lib/purecloudplatformclientv2/models/property_index_request.rb +3 -3
  1430. data/lib/purecloudplatformclientv2/models/provision_info.rb +3 -3
  1431. data/lib/purecloudplatformclientv2/models/publish_draft_input.rb +3 -3
  1432. data/lib/purecloudplatformclientv2/models/publish_form.rb +3 -3
  1433. data/lib/purecloudplatformclientv2/models/published_survey_form_reference.rb +3 -3
  1434. data/lib/purecloudplatformclientv2/models/pure_cloud.rb +3 -3
  1435. data/lib/purecloudplatformclientv2/models/qualifier_mapping_observation_query_response.rb +3 -3
  1436. data/lib/purecloudplatformclientv2/models/quality_audit.rb +3 -3
  1437. data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +16 -16
  1438. data/lib/purecloudplatformclientv2/models/query_division.rb +3 -3
  1439. data/lib/purecloudplatformclientv2/models/query_facet_info.rb +3 -3
  1440. data/lib/purecloudplatformclientv2/models/query_request.rb +3 -3
  1441. data/lib/purecloudplatformclientv2/models/query_result.rb +3 -3
  1442. data/lib/purecloudplatformclientv2/models/query_results.rb +3 -3
  1443. data/lib/purecloudplatformclientv2/models/queue.rb +3 -3
  1444. data/lib/purecloudplatformclientv2/models/queue_conversation_call_event_topic_call_conversation.rb +3 -3
  1445. data/lib/purecloudplatformclientv2/models/queue_conversation_call_event_topic_call_media_participant.rb +29 -4
  1446. data/lib/purecloudplatformclientv2/models/queue_conversation_call_event_topic_detail.rb +3 -3
  1447. data/lib/purecloudplatformclientv2/models/queue_conversation_call_event_topic_error_body.rb +3 -3
  1448. data/lib/purecloudplatformclientv2/models/queue_conversation_call_event_topic_fax_status.rb +3 -3
  1449. data/lib/purecloudplatformclientv2/models/queue_conversation_call_event_topic_journey_action.rb +226 -0
  1450. data/lib/purecloudplatformclientv2/models/queue_conversation_call_event_topic_journey_action_map.rb +226 -0
  1451. data/lib/purecloudplatformclientv2/models/queue_conversation_call_event_topic_journey_context.rb +251 -0
  1452. data/lib/purecloudplatformclientv2/models/queue_conversation_call_event_topic_journey_customer.rb +226 -0
  1453. data/lib/purecloudplatformclientv2/models/queue_conversation_call_event_topic_journey_customer_session.rb +226 -0
  1454. data/lib/purecloudplatformclientv2/models/queue_conversation_call_event_topic_uri_reference.rb +3 -3
  1455. data/lib/purecloudplatformclientv2/models/queue_conversation_call_event_topic_wrapup.rb +3 -3
  1456. data/lib/purecloudplatformclientv2/models/queue_conversation_callback_event_topic_callback_conversation.rb +3 -3
  1457. data/lib/purecloudplatformclientv2/models/queue_conversation_callback_event_topic_callback_media_participant.rb +29 -4
  1458. data/lib/purecloudplatformclientv2/models/queue_conversation_callback_event_topic_detail.rb +3 -3
  1459. data/lib/purecloudplatformclientv2/models/queue_conversation_callback_event_topic_dialer_preview.rb +3 -3
  1460. data/lib/purecloudplatformclientv2/models/queue_conversation_callback_event_topic_error_body.rb +3 -3
  1461. data/lib/purecloudplatformclientv2/models/queue_conversation_callback_event_topic_journey_action.rb +226 -0
  1462. data/lib/purecloudplatformclientv2/models/queue_conversation_callback_event_topic_journey_action_map.rb +226 -0
  1463. data/lib/purecloudplatformclientv2/models/queue_conversation_callback_event_topic_journey_context.rb +251 -0
  1464. data/lib/purecloudplatformclientv2/models/queue_conversation_callback_event_topic_journey_customer.rb +226 -0
  1465. data/lib/purecloudplatformclientv2/models/queue_conversation_callback_event_topic_journey_customer_session.rb +226 -0
  1466. data/lib/purecloudplatformclientv2/models/queue_conversation_callback_event_topic_phone_number_column.rb +3 -3
  1467. data/lib/purecloudplatformclientv2/models/queue_conversation_callback_event_topic_uri_reference.rb +3 -3
  1468. data/lib/purecloudplatformclientv2/models/queue_conversation_callback_event_topic_voicemail.rb +3 -3
  1469. data/lib/purecloudplatformclientv2/models/queue_conversation_callback_event_topic_wrapup.rb +3 -3
  1470. data/lib/purecloudplatformclientv2/models/queue_conversation_chat_event_topic_chat_conversation.rb +3 -3
  1471. data/lib/purecloudplatformclientv2/models/queue_conversation_chat_event_topic_chat_media_participant.rb +29 -4
  1472. data/lib/purecloudplatformclientv2/models/queue_conversation_chat_event_topic_detail.rb +3 -3
  1473. data/lib/purecloudplatformclientv2/models/queue_conversation_chat_event_topic_error_body.rb +3 -3
  1474. data/lib/purecloudplatformclientv2/models/queue_conversation_chat_event_topic_journey_action.rb +226 -0
  1475. data/lib/purecloudplatformclientv2/models/queue_conversation_chat_event_topic_journey_action_map.rb +226 -0
  1476. data/lib/purecloudplatformclientv2/models/queue_conversation_chat_event_topic_journey_context.rb +251 -0
  1477. data/lib/purecloudplatformclientv2/models/queue_conversation_chat_event_topic_journey_customer.rb +226 -0
  1478. data/lib/purecloudplatformclientv2/models/queue_conversation_chat_event_topic_journey_customer_session.rb +226 -0
  1479. data/lib/purecloudplatformclientv2/models/queue_conversation_chat_event_topic_uri_reference.rb +3 -3
  1480. data/lib/purecloudplatformclientv2/models/queue_conversation_chat_event_topic_wrapup.rb +3 -3
  1481. data/lib/purecloudplatformclientv2/models/queue_conversation_cobrowse_event_topic_cobrowse_conversation.rb +3 -3
  1482. data/lib/purecloudplatformclientv2/models/queue_conversation_cobrowse_event_topic_cobrowse_media_participant.rb +29 -4
  1483. data/lib/purecloudplatformclientv2/models/queue_conversation_cobrowse_event_topic_detail.rb +3 -3
  1484. data/lib/purecloudplatformclientv2/models/queue_conversation_cobrowse_event_topic_error_body.rb +3 -3
  1485. data/lib/purecloudplatformclientv2/models/queue_conversation_cobrowse_event_topic_journey_action.rb +226 -0
  1486. data/lib/purecloudplatformclientv2/models/queue_conversation_cobrowse_event_topic_journey_action_map.rb +226 -0
  1487. data/lib/purecloudplatformclientv2/models/queue_conversation_cobrowse_event_topic_journey_context.rb +251 -0
  1488. data/lib/purecloudplatformclientv2/models/queue_conversation_cobrowse_event_topic_journey_customer.rb +226 -0
  1489. data/lib/purecloudplatformclientv2/models/queue_conversation_cobrowse_event_topic_journey_customer_session.rb +226 -0
  1490. data/lib/purecloudplatformclientv2/models/queue_conversation_cobrowse_event_topic_uri_reference.rb +3 -3
  1491. data/lib/purecloudplatformclientv2/models/queue_conversation_cobrowse_event_topic_wrapup.rb +3 -3
  1492. data/lib/purecloudplatformclientv2/models/queue_conversation_email_event_topic_attachment.rb +3 -3
  1493. data/lib/purecloudplatformclientv2/models/queue_conversation_email_event_topic_detail.rb +3 -3
  1494. data/lib/purecloudplatformclientv2/models/queue_conversation_email_event_topic_email_conversation.rb +3 -3
  1495. data/lib/purecloudplatformclientv2/models/queue_conversation_email_event_topic_email_media_participant.rb +29 -4
  1496. data/lib/purecloudplatformclientv2/models/queue_conversation_email_event_topic_error_body.rb +3 -3
  1497. data/lib/purecloudplatformclientv2/models/queue_conversation_email_event_topic_journey_action.rb +226 -0
  1498. data/lib/purecloudplatformclientv2/models/queue_conversation_email_event_topic_journey_action_map.rb +226 -0
  1499. data/lib/purecloudplatformclientv2/models/queue_conversation_email_event_topic_journey_context.rb +251 -0
  1500. data/lib/purecloudplatformclientv2/models/queue_conversation_email_event_topic_journey_customer.rb +226 -0
  1501. data/lib/purecloudplatformclientv2/models/queue_conversation_email_event_topic_journey_customer_session.rb +226 -0
  1502. data/lib/purecloudplatformclientv2/models/queue_conversation_email_event_topic_uri_reference.rb +3 -3
  1503. data/lib/purecloudplatformclientv2/models/queue_conversation_email_event_topic_wrapup.rb +3 -3
  1504. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_address.rb +3 -3
  1505. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_attachment.rb +3 -3
  1506. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_call.rb +3 -3
  1507. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_callback.rb +3 -3
  1508. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_chat.rb +29 -4
  1509. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_cobrowse.rb +3 -3
  1510. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_conversation.rb +3 -3
  1511. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_dialer_preview.rb +3 -3
  1512. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_disconnect_reason.rb +3 -3
  1513. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_email.rb +3 -3
  1514. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_error_details.rb +3 -3
  1515. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_fax_status.rb +3 -3
  1516. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_journey_action.rb +226 -0
  1517. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_journey_action_map.rb +226 -0
  1518. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_journey_context.rb +251 -0
  1519. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_journey_customer.rb +226 -0
  1520. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_journey_customer_session.rb +226 -0
  1521. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_message.rb +3 -3
  1522. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_message_details.rb +3 -3
  1523. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_message_media.rb +3 -3
  1524. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_message_sticker.rb +3 -3
  1525. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_participant.rb +3 -3
  1526. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_phone_number_column.rb +3 -3
  1527. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_screenshare.rb +3 -3
  1528. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_social_expression.rb +3 -3
  1529. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_video.rb +3 -3
  1530. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_voicemail.rb +3 -3
  1531. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_wrapup.rb +3 -3
  1532. data/lib/purecloudplatformclientv2/models/queue_conversation_message_event_topic_detail.rb +3 -3
  1533. data/lib/purecloudplatformclientv2/models/queue_conversation_message_event_topic_error_body.rb +3 -3
  1534. data/lib/purecloudplatformclientv2/models/queue_conversation_message_event_topic_journey_action.rb +226 -0
  1535. data/lib/purecloudplatformclientv2/models/queue_conversation_message_event_topic_journey_action_map.rb +226 -0
  1536. data/lib/purecloudplatformclientv2/models/queue_conversation_message_event_topic_journey_context.rb +251 -0
  1537. data/lib/purecloudplatformclientv2/models/queue_conversation_message_event_topic_journey_customer.rb +226 -0
  1538. data/lib/purecloudplatformclientv2/models/queue_conversation_message_event_topic_journey_customer_session.rb +226 -0
  1539. data/lib/purecloudplatformclientv2/models/queue_conversation_message_event_topic_message_conversation.rb +3 -3
  1540. data/lib/purecloudplatformclientv2/models/queue_conversation_message_event_topic_message_details.rb +3 -3
  1541. data/lib/purecloudplatformclientv2/models/queue_conversation_message_event_topic_message_media.rb +3 -3
  1542. data/lib/purecloudplatformclientv2/models/queue_conversation_message_event_topic_message_media_participant.rb +29 -4
  1543. data/lib/purecloudplatformclientv2/models/queue_conversation_message_event_topic_message_sticker.rb +3 -3
  1544. data/lib/purecloudplatformclientv2/models/queue_conversation_message_event_topic_uri_reference.rb +3 -3
  1545. data/lib/purecloudplatformclientv2/models/queue_conversation_message_event_topic_wrapup.rb +3 -3
  1546. data/lib/purecloudplatformclientv2/models/queue_conversation_screen_share_event_topic_detail.rb +3 -3
  1547. data/lib/purecloudplatformclientv2/models/queue_conversation_screen_share_event_topic_error_body.rb +3 -3
  1548. data/lib/purecloudplatformclientv2/models/queue_conversation_screen_share_event_topic_journey_action.rb +226 -0
  1549. data/lib/purecloudplatformclientv2/models/queue_conversation_screen_share_event_topic_journey_action_map.rb +226 -0
  1550. data/lib/purecloudplatformclientv2/models/queue_conversation_screen_share_event_topic_journey_context.rb +251 -0
  1551. data/lib/purecloudplatformclientv2/models/queue_conversation_screen_share_event_topic_journey_customer.rb +226 -0
  1552. data/lib/purecloudplatformclientv2/models/queue_conversation_screen_share_event_topic_journey_customer_session.rb +226 -0
  1553. data/lib/purecloudplatformclientv2/models/queue_conversation_screen_share_event_topic_screen_share_conversation.rb +3 -3
  1554. data/lib/purecloudplatformclientv2/models/queue_conversation_screen_share_event_topic_screen_share_media_participant.rb +29 -4
  1555. data/lib/purecloudplatformclientv2/models/queue_conversation_screen_share_event_topic_uri_reference.rb +3 -3
  1556. data/lib/purecloudplatformclientv2/models/queue_conversation_screen_share_event_topic_wrapup.rb +3 -3
  1557. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_address.rb +3 -3
  1558. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_attachment.rb +3 -3
  1559. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_call.rb +3 -3
  1560. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_callback.rb +3 -3
  1561. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_chat.rb +29 -4
  1562. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_cobrowse.rb +3 -3
  1563. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_conversation.rb +3 -3
  1564. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_dialer_preview.rb +3 -3
  1565. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_disconnect_reason.rb +3 -3
  1566. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_email.rb +3 -3
  1567. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_error_details.rb +3 -3
  1568. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_fax_status.rb +3 -3
  1569. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_journey_action.rb +226 -0
  1570. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_journey_action_map.rb +226 -0
  1571. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_journey_context.rb +251 -0
  1572. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_journey_customer.rb +226 -0
  1573. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_journey_customer_session.rb +226 -0
  1574. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_message.rb +3 -3
  1575. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_message_details.rb +3 -3
  1576. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_message_media.rb +3 -3
  1577. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_message_sticker.rb +3 -3
  1578. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_participant.rb +3 -3
  1579. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_phone_number_column.rb +3 -3
  1580. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_screenshare.rb +3 -3
  1581. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_social_expression.rb +3 -3
  1582. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_video.rb +3 -3
  1583. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_voicemail.rb +3 -3
  1584. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_wrapup.rb +3 -3
  1585. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_address.rb +3 -3
  1586. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_attachment.rb +3 -3
  1587. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_call.rb +3 -3
  1588. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_callback.rb +3 -3
  1589. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_chat.rb +29 -4
  1590. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_cobrowse.rb +3 -3
  1591. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_conversation.rb +3 -3
  1592. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_dialer_preview.rb +3 -3
  1593. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_disconnect_reason.rb +3 -3
  1594. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_email.rb +3 -3
  1595. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_error_details.rb +3 -3
  1596. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_fax_status.rb +3 -3
  1597. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_journey_action.rb +226 -0
  1598. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_journey_action_map.rb +226 -0
  1599. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_journey_context.rb +251 -0
  1600. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_journey_customer.rb +226 -0
  1601. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_journey_customer_session.rb +226 -0
  1602. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_message.rb +3 -3
  1603. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_message_details.rb +3 -3
  1604. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_message_media.rb +3 -3
  1605. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_message_sticker.rb +3 -3
  1606. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_participant.rb +3 -3
  1607. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_phone_number_column.rb +3 -3
  1608. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_screenshare.rb +3 -3
  1609. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_social_expression.rb +3 -3
  1610. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_video.rb +3 -3
  1611. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_voicemail.rb +3 -3
  1612. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_wrapup.rb +3 -3
  1613. data/lib/purecloudplatformclientv2/models/queue_email_address.rb +3 -3
  1614. data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +16 -16
  1615. data/lib/purecloudplatformclientv2/models/queue_media_association.rb +3 -3
  1616. data/lib/purecloudplatformclientv2/models/queue_member.rb +3 -3
  1617. data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +16 -16
  1618. data/lib/purecloudplatformclientv2/models/queue_messaging_addresses.rb +3 -3
  1619. data/lib/purecloudplatformclientv2/models/queue_reference.rb +3 -3
  1620. data/lib/purecloudplatformclientv2/models/queue_request.rb +3 -3
  1621. data/lib/purecloudplatformclientv2/models/queue_user_event_topic_queue_member.rb +3 -3
  1622. data/lib/purecloudplatformclientv2/models/queue_utilization_diagnostic.rb +3 -3
  1623. data/lib/purecloudplatformclientv2/models/reaction.rb +3 -3
  1624. data/lib/purecloudplatformclientv2/models/recall_entry.rb +3 -3
  1625. data/lib/purecloudplatformclientv2/models/recipient.rb +3 -3
  1626. data/lib/purecloudplatformclientv2/models/recipient_listing.rb +16 -16
  1627. data/lib/purecloudplatformclientv2/models/recording.rb +3 -3
  1628. data/lib/purecloudplatformclientv2/models/recording_email_message.rb +3 -3
  1629. data/lib/purecloudplatformclientv2/models/recording_messaging_message.rb +3 -3
  1630. data/lib/purecloudplatformclientv2/models/recording_settings.rb +3 -3
  1631. data/lib/purecloudplatformclientv2/models/referrer.rb +444 -0
  1632. data/lib/purecloudplatformclientv2/models/region_time_zone.rb +3 -3
  1633. data/lib/purecloudplatformclientv2/models/relationship.rb +3 -3
  1634. data/lib/purecloudplatformclientv2/models/relationship_listing.rb +16 -16
  1635. data/lib/purecloudplatformclientv2/models/replace_request.rb +3 -3
  1636. data/lib/purecloudplatformclientv2/models/replace_response.rb +3 -3
  1637. data/lib/purecloudplatformclientv2/models/replacement_term.rb +3 -3
  1638. data/lib/purecloudplatformclientv2/models/report_meta_data.rb +3 -3
  1639. data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +16 -16
  1640. data/lib/purecloudplatformclientv2/models/report_run_entry.rb +3 -3
  1641. data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +16 -16
  1642. data/lib/purecloudplatformclientv2/models/report_schedule.rb +3 -3
  1643. data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +16 -16
  1644. data/lib/purecloudplatformclientv2/models/reporting_data_export_topic_data_export_notification.rb +5 -5
  1645. data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +16 -16
  1646. data/lib/purecloudplatformclientv2/models/reporting_export_job_request.rb +3 -3
  1647. data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +5 -5
  1648. data/lib/purecloudplatformclientv2/models/request_config.rb +3 -3
  1649. data/lib/purecloudplatformclientv2/models/reschedule_request.rb +3 -3
  1650. data/lib/purecloudplatformclientv2/models/reschedule_result.rb +3 -3
  1651. data/lib/purecloudplatformclientv2/models/rescheduling_options_response.rb +3 -3
  1652. data/lib/purecloudplatformclientv2/models/resource_condition_node.rb +3 -3
  1653. data/lib/purecloudplatformclientv2/models/resource_condition_value.rb +3 -3
  1654. data/lib/purecloudplatformclientv2/models/resource_permission_policy.rb +3 -3
  1655. data/lib/purecloudplatformclientv2/models/response.rb +3 -3
  1656. data/lib/purecloudplatformclientv2/models/response_config.rb +3 -3
  1657. data/lib/purecloudplatformclientv2/models/response_entity_list.rb +16 -16
  1658. data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +16 -16
  1659. data/lib/purecloudplatformclientv2/models/response_filter.rb +3 -3
  1660. data/lib/purecloudplatformclientv2/models/response_query_request.rb +3 -3
  1661. data/lib/purecloudplatformclientv2/models/response_query_results.rb +3 -3
  1662. data/lib/purecloudplatformclientv2/models/response_set.rb +3 -3
  1663. data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +16 -16
  1664. data/lib/purecloudplatformclientv2/models/response_substitution.rb +3 -3
  1665. data/lib/purecloudplatformclientv2/models/response_text.rb +3 -3
  1666. data/lib/purecloudplatformclientv2/models/rest_error_detail.rb +3 -3
  1667. data/lib/purecloudplatformclientv2/models/retention_duration.rb +3 -3
  1668. data/lib/purecloudplatformclientv2/models/reverse_whitepages_lookup_result.rb +3 -3
  1669. data/lib/purecloudplatformclientv2/models/ring.rb +3 -3
  1670. data/lib/purecloudplatformclientv2/models/role_division.rb +3 -3
  1671. data/lib/purecloudplatformclientv2/models/route_group.rb +3 -3
  1672. data/lib/purecloudplatformclientv2/models/route_group_attributes.rb +3 -3
  1673. data/lib/purecloudplatformclientv2/models/route_group_list.rb +3 -3
  1674. data/lib/purecloudplatformclientv2/models/routing_data.rb +3 -3
  1675. data/lib/purecloudplatformclientv2/models/routing_skill.rb +3 -3
  1676. data/lib/purecloudplatformclientv2/models/routing_skill_reference.rb +3 -3
  1677. data/lib/purecloudplatformclientv2/models/routing_status.rb +3 -3
  1678. data/lib/purecloudplatformclientv2/models/rule_set.rb +3 -3
  1679. data/lib/purecloudplatformclientv2/models/rule_set_diagnostic.rb +3 -3
  1680. data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +16 -16
  1681. data/lib/purecloudplatformclientv2/models/run_now_response.rb +3 -3
  1682. data/lib/purecloudplatformclientv2/models/salesforce.rb +3 -3
  1683. data/lib/purecloudplatformclientv2/models/schedule.rb +3 -3
  1684. data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +16 -16
  1685. data/lib/purecloudplatformclientv2/models/schedule_generation_warning.rb +3 -3
  1686. data/lib/purecloudplatformclientv2/models/schedule_group.rb +3 -3
  1687. data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +16 -16
  1688. data/lib/purecloudplatformclientv2/models/schedule_interval.rb +3 -3
  1689. data/lib/purecloudplatformclientv2/models/scheduling_processing_error.rb +242 -0
  1690. data/lib/purecloudplatformclientv2/models/scheduling_run_list_response.rb +3 -3
  1691. data/lib/purecloudplatformclientv2/models/scheduling_run_response.rb +3 -3
  1692. data/lib/purecloudplatformclientv2/models/scheduling_settings.rb +3 -3
  1693. data/lib/purecloudplatformclientv2/models/scheduling_status_response.rb +322 -0
  1694. data/lib/purecloudplatformclientv2/models/schema_category.rb +3 -3
  1695. data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +16 -16
  1696. data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +16 -16
  1697. data/lib/purecloudplatformclientv2/models/scorable_survey.rb +3 -3
  1698. data/lib/purecloudplatformclientv2/models/screen_recording_session.rb +3 -3
  1699. data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +16 -16
  1700. data/lib/purecloudplatformclientv2/models/screen_recording_session_request.rb +3 -3
  1701. data/lib/purecloudplatformclientv2/models/screenshare.rb +30 -4
  1702. data/lib/purecloudplatformclientv2/models/script.rb +3 -3
  1703. data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +16 -16
  1704. data/lib/purecloudplatformclientv2/models/search_aggregation.rb +3 -3
  1705. data/lib/purecloudplatformclientv2/models/search_criteria.rb +3 -3
  1706. data/lib/purecloudplatformclientv2/models/search_request.rb +3 -3
  1707. data/lib/purecloudplatformclientv2/models/search_shift_trade_response.rb +256 -0
  1708. data/lib/purecloudplatformclientv2/models/search_shift_trades_request.rb +235 -0
  1709. data/lib/purecloudplatformclientv2/models/search_shift_trades_response.rb +204 -0
  1710. data/lib/purecloudplatformclientv2/models/search_sort.rb +3 -3
  1711. data/lib/purecloudplatformclientv2/models/section.rb +3 -3
  1712. data/lib/purecloudplatformclientv2/models/secure_session.rb +3 -3
  1713. data/lib/purecloudplatformclientv2/models/secure_session_entity_listing.rb +3 -3
  1714. data/lib/purecloudplatformclientv2/models/security_profile.rb +3 -3
  1715. data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +16 -16
  1716. data/lib/purecloudplatformclientv2/models/segment.rb +3 -3
  1717. data/lib/purecloudplatformclientv2/models/segment_assigned_event.rb +441 -0
  1718. data/lib/purecloudplatformclientv2/models/sequence_schedule.rb +3 -3
  1719. data/lib/purecloudplatformclientv2/models/server_date.rb +3 -3
  1720. data/lib/purecloudplatformclientv2/models/service_context.rb +3 -3
  1721. data/lib/purecloudplatformclientv2/models/service_goal_group.rb +3 -3
  1722. data/lib/purecloudplatformclientv2/models/service_goal_group_goals.rb +3 -3
  1723. data/lib/purecloudplatformclientv2/models/service_goal_group_list.rb +3 -3
  1724. data/lib/purecloudplatformclientv2/models/service_level.rb +3 -3
  1725. data/lib/purecloudplatformclientv2/models/session.rb +253 -0
  1726. data/lib/purecloudplatformclientv2/models/set_uui_data_request.rb +3 -3
  1727. data/lib/purecloudplatformclientv2/models/set_wrapper_day_of_week.rb +3 -3
  1728. data/lib/purecloudplatformclientv2/models/share.rb +3 -3
  1729. data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +16 -16
  1730. data/lib/purecloudplatformclientv2/models/shared_entity.rb +3 -3
  1731. data/lib/purecloudplatformclientv2/models/shared_response.rb +3 -3
  1732. data/lib/purecloudplatformclientv2/models/shift_start_variance.rb +3 -3
  1733. data/lib/purecloudplatformclientv2/models/shift_trade_activity_preview_response.rb +280 -0
  1734. data/lib/purecloudplatformclientv2/models/shift_trade_activity_rule.rb +292 -0
  1735. data/lib/purecloudplatformclientv2/models/shift_trade_list_response.rb +203 -0
  1736. data/lib/purecloudplatformclientv2/models/shift_trade_match_review_response.rb +284 -0
  1737. data/lib/purecloudplatformclientv2/models/shift_trade_match_review_user_response.rb +306 -0
  1738. data/lib/purecloudplatformclientv2/models/shift_trade_match_violation.rb +244 -0
  1739. data/lib/purecloudplatformclientv2/models/shift_trade_matches_summary_response.rb +203 -0
  1740. data/lib/purecloudplatformclientv2/models/shift_trade_notification.rb +398 -0
  1741. data/lib/purecloudplatformclientv2/models/shift_trade_preview_response.rb +204 -0
  1742. data/lib/purecloudplatformclientv2/models/shift_trade_response.rb +659 -0
  1743. data/lib/purecloudplatformclientv2/models/shift_trade_response_acceptable_intervals.rb +228 -0
  1744. data/lib/purecloudplatformclientv2/models/shift_trade_settings.rb +546 -0
  1745. data/lib/purecloudplatformclientv2/models/short_term_forecast.rb +3 -3
  1746. data/lib/purecloudplatformclientv2/models/short_term_forecast_list_item_response.rb +3 -3
  1747. data/lib/purecloudplatformclientv2/models/short_term_forecast_list_response.rb +3 -3
  1748. data/lib/purecloudplatformclientv2/models/short_term_forecast_reference.rb +3 -3
  1749. data/lib/purecloudplatformclientv2/models/short_term_forecast_response.rb +3 -3
  1750. data/lib/purecloudplatformclientv2/models/short_term_forecasting_settings.rb +3 -3
  1751. data/lib/purecloudplatformclientv2/models/shrinkage_override.rb +3 -3
  1752. data/lib/purecloudplatformclientv2/models/shrinkage_overrides.rb +3 -3
  1753. data/lib/purecloudplatformclientv2/models/site.rb +3 -3
  1754. data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +16 -16
  1755. data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +16 -16
  1756. data/lib/purecloudplatformclientv2/models/skills_to_remove.rb +3 -3
  1757. data/lib/purecloudplatformclientv2/models/sms_address_provision.rb +3 -3
  1758. data/lib/purecloudplatformclientv2/models/sms_available_phone_number.rb +3 -3
  1759. data/lib/purecloudplatformclientv2/models/sms_available_phone_number_entity_listing.rb +3 -3
  1760. data/lib/purecloudplatformclientv2/models/sms_phone_number.rb +3 -3
  1761. data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +16 -16
  1762. data/lib/purecloudplatformclientv2/models/sms_phone_number_provision.rb +3 -3
  1763. data/lib/purecloudplatformclientv2/models/social_expression.rb +30 -4
  1764. data/lib/purecloudplatformclientv2/models/sort_item.rb +3 -3
  1765. data/lib/purecloudplatformclientv2/models/stat_event_campaign_topic_datum.rb +3 -3
  1766. data/lib/purecloudplatformclientv2/models/stat_event_campaign_topic_metric.rb +3 -3
  1767. data/lib/purecloudplatformclientv2/models/stat_event_campaign_topic_stats_notification.rb +3 -3
  1768. data/lib/purecloudplatformclientv2/models/stat_event_queue_topic_datum.rb +3 -3
  1769. data/lib/purecloudplatformclientv2/models/stat_event_queue_topic_metric.rb +3 -3
  1770. data/lib/purecloudplatformclientv2/models/stat_event_queue_topic_stats_notification.rb +3 -3
  1771. data/lib/purecloudplatformclientv2/models/stat_event_user_topic_datum.rb +3 -3
  1772. data/lib/purecloudplatformclientv2/models/stat_event_user_topic_metric.rb +3 -3
  1773. data/lib/purecloudplatformclientv2/models/stat_event_user_topic_stats_notification.rb +3 -3
  1774. data/lib/purecloudplatformclientv2/models/station.rb +3 -3
  1775. data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +16 -16
  1776. data/lib/purecloudplatformclientv2/models/station_settings.rb +3 -3
  1777. data/lib/purecloudplatformclientv2/models/statistical_response.rb +3 -3
  1778. data/lib/purecloudplatformclientv2/models/statistical_summary.rb +3 -3
  1779. data/lib/purecloudplatformclientv2/models/street_address.rb +3 -3
  1780. data/lib/purecloudplatformclientv2/models/subject_division_grants.rb +3 -3
  1781. data/lib/purecloudplatformclientv2/models/subject_division_grants_entity_listing.rb +16 -16
  1782. data/lib/purecloudplatformclientv2/models/subject_divisions.rb +3 -3
  1783. data/lib/purecloudplatformclientv2/models/subscriber_response.rb +3 -3
  1784. data/lib/purecloudplatformclientv2/models/subscription_overview_usage.rb +3 -3
  1785. data/lib/purecloudplatformclientv2/models/suggest_search_criteria.rb +3 -3
  1786. data/lib/purecloudplatformclientv2/models/suggest_search_request.rb +3 -3
  1787. data/lib/purecloudplatformclientv2/models/survey.rb +3 -3
  1788. data/lib/purecloudplatformclientv2/models/survey_assignment.rb +3 -3
  1789. data/lib/purecloudplatformclientv2/models/survey_form.rb +3 -3
  1790. data/lib/purecloudplatformclientv2/models/survey_form_and_scoring_set.rb +3 -3
  1791. data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +16 -16
  1792. data/lib/purecloudplatformclientv2/models/survey_question.rb +3 -3
  1793. data/lib/purecloudplatformclientv2/models/survey_question_group.rb +3 -3
  1794. data/lib/purecloudplatformclientv2/models/survey_question_group_score.rb +3 -3
  1795. data/lib/purecloudplatformclientv2/models/survey_question_score.rb +3 -3
  1796. data/lib/purecloudplatformclientv2/models/survey_scoring_set.rb +3 -3
  1797. data/lib/purecloudplatformclientv2/models/system_message_system_message.rb +3 -3
  1798. data/lib/purecloudplatformclientv2/models/system_presence.rb +3 -3
  1799. data/lib/purecloudplatformclientv2/models/system_prompt.rb +3 -3
  1800. data/lib/purecloudplatformclientv2/models/system_prompt_asset.rb +3 -3
  1801. data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +16 -16
  1802. data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +16 -16
  1803. data/lib/purecloudplatformclientv2/models/tag_query_request.rb +3 -3
  1804. data/lib/purecloudplatformclientv2/models/tag_value.rb +3 -3
  1805. data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +16 -16
  1806. data/lib/purecloudplatformclientv2/models/term_attribute.rb +3 -3
  1807. data/lib/purecloudplatformclientv2/models/test_execution_operation_result.rb +3 -3
  1808. data/lib/purecloudplatformclientv2/models/test_execution_result.rb +3 -3
  1809. data/lib/purecloudplatformclientv2/models/text_message_listing.rb +16 -16
  1810. data/lib/purecloudplatformclientv2/models/ticker.rb +3 -3
  1811. data/lib/purecloudplatformclientv2/models/time_allowed.rb +3 -3
  1812. data/lib/purecloudplatformclientv2/models/time_interval.rb +3 -3
  1813. data/lib/purecloudplatformclientv2/models/time_off_request_entity_list.rb +3 -3
  1814. data/lib/purecloudplatformclientv2/models/time_off_request_list.rb +3 -3
  1815. data/lib/purecloudplatformclientv2/models/time_off_request_lookup.rb +3 -3
  1816. data/lib/purecloudplatformclientv2/models/time_off_request_lookup_list.rb +3 -3
  1817. data/lib/purecloudplatformclientv2/models/time_off_request_query_body.rb +3 -3
  1818. data/lib/purecloudplatformclientv2/models/time_off_request_response.rb +3 -3
  1819. data/lib/purecloudplatformclientv2/models/time_off_request_settings.rb +3 -3
  1820. data/lib/purecloudplatformclientv2/models/time_slot.rb +3 -3
  1821. data/lib/purecloudplatformclientv2/models/time_zone.rb +3 -3
  1822. data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +16 -16
  1823. data/lib/purecloudplatformclientv2/models/time_zone_mapping_preview.rb +3 -3
  1824. data/lib/purecloudplatformclientv2/models/token.rb +3 -3
  1825. data/lib/purecloudplatformclientv2/models/token_info.rb +3 -3
  1826. data/lib/purecloudplatformclientv2/models/transfer_request.rb +3 -3
  1827. data/lib/purecloudplatformclientv2/models/trunk.rb +3 -3
  1828. data/lib/purecloudplatformclientv2/models/trunk_base.rb +3 -3
  1829. data/lib/purecloudplatformclientv2/models/trunk_base_assignment.rb +3 -3
  1830. data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +16 -16
  1831. data/lib/purecloudplatformclientv2/models/trunk_connected_status.rb +3 -3
  1832. data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +16 -16
  1833. data/lib/purecloudplatformclientv2/models/trunk_error_info.rb +3 -3
  1834. data/lib/purecloudplatformclientv2/models/trunk_error_info_details.rb +3 -3
  1835. data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +16 -16
  1836. data/lib/purecloudplatformclientv2/models/trunk_metrics.rb +3 -3
  1837. data/lib/purecloudplatformclientv2/models/trunk_metrics_calls.rb +3 -3
  1838. data/lib/purecloudplatformclientv2/models/trunk_metrics_network_type_ip.rb +3 -3
  1839. data/lib/purecloudplatformclientv2/models/trunk_metrics_options.rb +3 -3
  1840. data/lib/purecloudplatformclientv2/models/trunk_metrics_qo_s.rb +3 -3
  1841. data/lib/purecloudplatformclientv2/models/trunk_metrics_registers.rb +3 -3
  1842. data/lib/purecloudplatformclientv2/models/trunk_recording_enabled_count.rb +3 -3
  1843. data/lib/purecloudplatformclientv2/models/trust_create.rb +3 -3
  1844. data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +16 -16
  1845. data/lib/purecloudplatformclientv2/models/trust_group.rb +3 -3
  1846. data/lib/purecloudplatformclientv2/models/trust_member_create.rb +3 -3
  1847. data/lib/purecloudplatformclientv2/models/trust_request.rb +3 -3
  1848. data/lib/purecloudplatformclientv2/models/trust_request_create.rb +3 -3
  1849. data/lib/purecloudplatformclientv2/models/trust_user.rb +3 -3
  1850. data/lib/purecloudplatformclientv2/models/trust_user_details.rb +3 -3
  1851. data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +16 -16
  1852. data/lib/purecloudplatformclientv2/models/trustee.rb +3 -3
  1853. data/lib/purecloudplatformclientv2/models/trustee_audit_query_request.rb +3 -3
  1854. data/lib/purecloudplatformclientv2/models/trustee_authorization.rb +3 -3
  1855. data/lib/purecloudplatformclientv2/models/trustee_billing_overview.rb +3 -3
  1856. data/lib/purecloudplatformclientv2/models/trustor.rb +3 -3
  1857. data/lib/purecloudplatformclientv2/models/trustor_audit_query_request.rb +3 -3
  1858. data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +16 -16
  1859. data/lib/purecloudplatformclientv2/models/twitter_id.rb +3 -3
  1860. data/lib/purecloudplatformclientv2/models/twitter_integration.rb +3 -3
  1861. data/lib/purecloudplatformclientv2/models/twitter_integration_entity_listing.rb +16 -16
  1862. data/lib/purecloudplatformclientv2/models/twitter_integration_request.rb +3 -3
  1863. data/lib/purecloudplatformclientv2/models/unread_metric.rb +3 -3
  1864. data/lib/purecloudplatformclientv2/models/unread_status.rb +3 -3
  1865. data/lib/purecloudplatformclientv2/models/unscheduled_agent_warning.rb +3 -3
  1866. data/lib/purecloudplatformclientv2/models/update_action_input.rb +3 -3
  1867. data/lib/purecloudplatformclientv2/models/update_activity_code_request.rb +3 -3
  1868. data/lib/purecloudplatformclientv2/models/update_agent_request.rb +202 -0
  1869. data/lib/purecloudplatformclientv2/models/update_draft_input.rb +3 -3
  1870. data/lib/purecloudplatformclientv2/models/update_notification_response.rb +228 -0
  1871. data/lib/purecloudplatformclientv2/models/update_notifications_request.rb +209 -0
  1872. data/lib/purecloudplatformclientv2/models/update_notifications_response.rb +203 -0
  1873. data/lib/purecloudplatformclientv2/models/update_scheduling_run_request.rb +3 -3
  1874. data/lib/purecloudplatformclientv2/models/update_shift_trade_request.rb +286 -0
  1875. data/lib/purecloudplatformclientv2/models/update_shift_trade_state_request.rb +252 -0
  1876. data/lib/purecloudplatformclientv2/models/update_user.rb +3 -3
  1877. data/lib/purecloudplatformclientv2/models/update_week_schedule_request.rb +3 -3
  1878. data/lib/purecloudplatformclientv2/models/uri_reference.rb +3 -3
  1879. data/lib/purecloudplatformclientv2/models/url_condition.rb +254 -0
  1880. data/lib/purecloudplatformclientv2/models/usage.rb +3 -3
  1881. data/lib/purecloudplatformclientv2/models/usage_item.rb +3 -3
  1882. data/lib/purecloudplatformclientv2/models/user.rb +3 -3
  1883. data/lib/purecloudplatformclientv2/models/user_action_category.rb +3 -3
  1884. data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +16 -16
  1885. data/lib/purecloudplatformclientv2/models/user_agent_info.rb +3 -3
  1886. data/lib/purecloudplatformclientv2/models/user_authorization.rb +3 -3
  1887. data/lib/purecloudplatformclientv2/models/user_conversation_summary.rb +3 -3
  1888. data/lib/purecloudplatformclientv2/models/user_conversations_event_media_summary.rb +3 -3
  1889. data/lib/purecloudplatformclientv2/models/user_conversations_event_media_summary_detail.rb +3 -3
  1890. data/lib/purecloudplatformclientv2/models/user_conversations_event_user_conversation_summary.rb +3 -3
  1891. data/lib/purecloudplatformclientv2/models/user_details_query.rb +3 -3
  1892. data/lib/purecloudplatformclientv2/models/user_device.rb +3 -3
  1893. data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +16 -16
  1894. data/lib/purecloudplatformclientv2/models/user_expands.rb +3 -3
  1895. data/lib/purecloudplatformclientv2/models/user_greeting_event_greeting.rb +3 -3
  1896. data/lib/purecloudplatformclientv2/models/user_greeting_event_greeting_audio_file.rb +3 -3
  1897. data/lib/purecloudplatformclientv2/models/user_greeting_event_greeting_owner.rb +3 -3
  1898. data/lib/purecloudplatformclientv2/models/user_image.rb +3 -3
  1899. data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +16 -16
  1900. data/lib/purecloudplatformclientv2/models/user_licenses.rb +255 -0
  1901. data/lib/purecloudplatformclientv2/models/user_licenses_entity_listing.rb +303 -0
  1902. data/lib/purecloudplatformclientv2/models/user_list_schedule_request_body.rb +33 -7
  1903. data/lib/purecloudplatformclientv2/models/user_me.rb +3 -3
  1904. data/lib/purecloudplatformclientv2/models/user_param.rb +3 -3
  1905. data/lib/purecloudplatformclientv2/models/user_presence.rb +3 -3
  1906. data/lib/purecloudplatformclientv2/models/user_profile.rb +3 -3
  1907. data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +16 -16
  1908. data/lib/purecloudplatformclientv2/models/user_queue.rb +3 -3
  1909. data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +16 -16
  1910. data/lib/purecloudplatformclientv2/models/user_recording.rb +3 -3
  1911. data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +16 -16
  1912. data/lib/purecloudplatformclientv2/models/user_reference.rb +3 -3
  1913. data/lib/purecloudplatformclientv2/models/user_routing_language.rb +3 -3
  1914. data/lib/purecloudplatformclientv2/models/user_routing_language_post.rb +3 -3
  1915. data/lib/purecloudplatformclientv2/models/user_routing_skill.rb +3 -3
  1916. data/lib/purecloudplatformclientv2/models/user_routing_skill_post.rb +3 -3
  1917. data/lib/purecloudplatformclientv2/models/user_routing_status_error_info.rb +3 -3
  1918. data/lib/purecloudplatformclientv2/models/user_routing_status_routing_status.rb +3 -3
  1919. data/lib/purecloudplatformclientv2/models/user_routing_status_user_param.rb +3 -3
  1920. data/lib/purecloudplatformclientv2/models/user_routing_status_user_routing_status.rb +3 -3
  1921. data/lib/purecloudplatformclientv2/models/user_schedule.rb +3 -3
  1922. data/lib/purecloudplatformclientv2/models/user_schedule_activity.rb +3 -3
  1923. data/lib/purecloudplatformclientv2/models/user_schedule_adherence.rb +58 -4
  1924. data/lib/purecloudplatformclientv2/models/user_schedule_container.rb +32 -4
  1925. data/lib/purecloudplatformclientv2/models/user_schedule_full_day_time_off_marker.rb +3 -3
  1926. data/lib/purecloudplatformclientv2/models/user_schedule_shift.rb +30 -4
  1927. data/lib/purecloudplatformclientv2/models/user_schedules_partial_upload_request.rb +3 -3
  1928. data/lib/purecloudplatformclientv2/models/user_search_criteria.rb +3 -3
  1929. data/lib/purecloudplatformclientv2/models/user_search_request.rb +3 -3
  1930. data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +16 -16
  1931. data/lib/purecloudplatformclientv2/models/user_station.rb +3 -3
  1932. data/lib/purecloudplatformclientv2/models/user_station_change_topic_user.rb +3 -3
  1933. data/lib/purecloudplatformclientv2/models/user_station_change_topic_user_station.rb +3 -3
  1934. data/lib/purecloudplatformclientv2/models/user_station_change_topic_user_stations.rb +3 -3
  1935. data/lib/purecloudplatformclientv2/models/user_stations.rb +3 -3
  1936. data/lib/purecloudplatformclientv2/models/users_search_response.rb +3 -3
  1937. data/lib/purecloudplatformclientv2/models/utilization.rb +3 -3
  1938. data/lib/purecloudplatformclientv2/models/validate_address_request.rb +3 -3
  1939. data/lib/purecloudplatformclientv2/models/validate_address_response.rb +3 -3
  1940. data/lib/purecloudplatformclientv2/models/vendor_connection_request.rb +3 -3
  1941. data/lib/purecloudplatformclientv2/models/video.rb +59 -7
  1942. data/lib/purecloudplatformclientv2/models/view_filter.rb +32 -4
  1943. data/lib/purecloudplatformclientv2/models/visibility_condition.rb +3 -3
  1944. data/lib/purecloudplatformclientv2/models/vm_pairing_info.rb +3 -3
  1945. data/lib/purecloudplatformclientv2/models/voicemail.rb +3 -3
  1946. data/lib/purecloudplatformclientv2/models/voicemail_copy_record.rb +3 -3
  1947. data/lib/purecloudplatformclientv2/models/voicemail_group_policy.rb +3 -3
  1948. data/lib/purecloudplatformclientv2/models/voicemail_mailbox_info.rb +3 -3
  1949. data/lib/purecloudplatformclientv2/models/voicemail_media_info.rb +3 -3
  1950. data/lib/purecloudplatformclientv2/models/voicemail_message.rb +3 -3
  1951. data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +16 -16
  1952. data/lib/purecloudplatformclientv2/models/voicemail_messages_topic_voicemail_message.rb +3 -3
  1953. data/lib/purecloudplatformclientv2/models/voicemail_organization_policy.rb +3 -3
  1954. data/lib/purecloudplatformclientv2/models/voicemail_retention_policy.rb +3 -3
  1955. data/lib/purecloudplatformclientv2/models/voicemail_search_criteria.rb +3 -3
  1956. data/lib/purecloudplatformclientv2/models/voicemail_search_request.rb +3 -3
  1957. data/lib/purecloudplatformclientv2/models/voicemail_user_policy.rb +3 -3
  1958. data/lib/purecloudplatformclientv2/models/voicemails_search_response.rb +3 -3
  1959. data/lib/purecloudplatformclientv2/models/web_action_event.rb +545 -0
  1960. data/lib/purecloudplatformclientv2/models/web_chat_config.rb +3 -3
  1961. data/lib/purecloudplatformclientv2/models/web_chat_deployment.rb +3 -3
  1962. data/lib/purecloudplatformclientv2/models/web_chat_deployment_entity_listing.rb +3 -3
  1963. data/lib/purecloudplatformclientv2/models/web_chat_settings.rb +3 -3
  1964. data/lib/purecloudplatformclientv2/models/web_event.rb +521 -0
  1965. data/lib/purecloudplatformclientv2/models/week_schedule.rb +4 -4
  1966. data/lib/purecloudplatformclientv2/models/week_schedule_generation_result.rb +3 -3
  1967. data/lib/purecloudplatformclientv2/models/week_schedule_list_item_response.rb +4 -4
  1968. data/lib/purecloudplatformclientv2/models/week_schedule_list_response.rb +3 -3
  1969. data/lib/purecloudplatformclientv2/models/week_schedule_reference.rb +254 -0
  1970. data/lib/purecloudplatformclientv2/models/week_schedule_response.rb +3 -3
  1971. data/lib/purecloudplatformclientv2/models/week_shift_trade_list_response.rb +203 -0
  1972. data/lib/purecloudplatformclientv2/models/week_shift_trade_matches_summary_response.rb +228 -0
  1973. data/lib/purecloudplatformclientv2/models/week_shift_trade_response.rb +228 -0
  1974. data/lib/purecloudplatformclientv2/models/wfm_abandon_rate.rb +3 -3
  1975. data/lib/purecloudplatformclientv2/models/wfm_agent.rb +30 -4
  1976. data/lib/purecloudplatformclientv2/models/wfm_agent_schedule_update_topic_user_reference.rb +3 -3
  1977. data/lib/purecloudplatformclientv2/models/wfm_agent_schedule_update_topic_wfm_agent_schedule_update.rb +3 -3
  1978. data/lib/purecloudplatformclientv2/models/wfm_agent_schedule_update_topic_wfm_agent_schedule_update_notification.rb +3 -3
  1979. data/lib/purecloudplatformclientv2/models/wfm_agent_schedule_update_topic_wfm_full_day_time_off_marker.rb +3 -3
  1980. data/lib/purecloudplatformclientv2/models/wfm_agent_schedule_update_topic_wfm_schedule_activity.rb +3 -3
  1981. data/lib/purecloudplatformclientv2/models/wfm_agent_schedule_update_topic_wfm_schedule_shift.rb +79 -4
  1982. data/lib/purecloudplatformclientv2/models/wfm_average_speed_of_answer.rb +3 -3
  1983. data/lib/purecloudplatformclientv2/models/wfm_forecast_modification.rb +3 -3
  1984. data/lib/purecloudplatformclientv2/models/wfm_forecast_modification_attributes.rb +3 -3
  1985. data/lib/purecloudplatformclientv2/models/wfm_forecast_modification_interval_offset_value.rb +3 -3
  1986. data/lib/purecloudplatformclientv2/models/wfm_historical_adherence_calculations_complete_topic_wfm_historical_adherence_calculations_comple.rb +3 -3
  1987. data/lib/purecloudplatformclientv2/models/wfm_historical_adherence_query.rb +3 -3
  1988. data/lib/purecloudplatformclientv2/models/wfm_historical_adherence_query_for_users.rb +3 -3
  1989. data/lib/purecloudplatformclientv2/models/wfm_historical_adherence_response.rb +3 -3
  1990. data/lib/purecloudplatformclientv2/models/wfm_intraday_data_update_topic_intraday_data_group.rb +3 -3
  1991. data/lib/purecloudplatformclientv2/models/wfm_intraday_data_update_topic_intraday_data_update.rb +3 -3
  1992. data/lib/purecloudplatformclientv2/models/wfm_intraday_data_update_topic_intraday_forecast_data.rb +3 -3
  1993. data/lib/purecloudplatformclientv2/models/wfm_intraday_data_update_topic_intraday_historical_agent_data.rb +3 -3
  1994. data/lib/purecloudplatformclientv2/models/wfm_intraday_data_update_topic_intraday_historical_queue_data.rb +3 -3
  1995. data/lib/purecloudplatformclientv2/models/wfm_intraday_data_update_topic_intraday_metric.rb +3 -3
  1996. data/lib/purecloudplatformclientv2/models/wfm_intraday_data_update_topic_intraday_performance_prediction_agent_data.rb +3 -3
  1997. data/lib/purecloudplatformclientv2/models/wfm_intraday_data_update_topic_intraday_performance_prediction_queue_data.rb +3 -3
  1998. data/lib/purecloudplatformclientv2/models/wfm_intraday_data_update_topic_intraday_schedule_data.rb +3 -3
  1999. data/lib/purecloudplatformclientv2/models/wfm_intraday_queue_listing.rb +3 -3
  2000. data/lib/purecloudplatformclientv2/models/wfm_move_agents_complete_topic_management_unit.rb +3 -3
  2001. data/lib/purecloudplatformclientv2/models/wfm_move_agents_complete_topic_user_reference.rb +3 -3
  2002. data/lib/purecloudplatformclientv2/models/wfm_move_agents_complete_topic_wfm_move_agent_data.rb +3 -3
  2003. data/lib/purecloudplatformclientv2/models/wfm_move_agents_complete_topic_wfm_move_agents_complete.rb +3 -3
  2004. data/lib/purecloudplatformclientv2/models/wfm_schedule_topic_wfm_schedule_notification.rb +3 -3
  2005. data/lib/purecloudplatformclientv2/models/wfm_service_level.rb +3 -3
  2006. data/lib/purecloudplatformclientv2/models/wfm_time_off_request_update_topic_time_off_request_update.rb +3 -3
  2007. data/lib/purecloudplatformclientv2/models/wfm_time_off_request_update_topic_user_reference.rb +3 -3
  2008. data/lib/purecloudplatformclientv2/models/wfm_time_zone.rb +3 -3
  2009. data/lib/purecloudplatformclientv2/models/wfm_update_agent_details_topic_wfm_update_agent_details_complete.rb +3 -3
  2010. data/lib/purecloudplatformclientv2/models/wfm_user_entity_listing.rb +3 -3
  2011. data/lib/purecloudplatformclientv2/models/wfm_user_notification.rb +415 -0
  2012. data/lib/purecloudplatformclientv2/models/wfm_user_notification_topic_shift_trade_notification.rb +390 -0
  2013. data/lib/purecloudplatformclientv2/models/wfm_user_notification_topic_user_reference.rb +201 -0
  2014. data/lib/purecloudplatformclientv2/models/wfm_user_notification_topic_wfm_user_notification.rb +367 -0
  2015. data/lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_topic_queue_reference.rb +201 -0
  2016. data/lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_topic_user_reference.rb +3 -3
  2017. data/lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_topic_user_schedule_adherence_update.rb +84 -7
  2018. data/lib/purecloudplatformclientv2/models/wfm_versioned_entity_metadata.rb +3 -3
  2019. data/lib/purecloudplatformclientv2/models/whats_app_id.rb +3 -3
  2020. data/lib/purecloudplatformclientv2/models/widget_client_config.rb +251 -0
  2021. data/lib/purecloudplatformclientv2/models/widget_client_config_third_party.rb +176 -0
  2022. data/lib/purecloudplatformclientv2/models/widget_client_config_v1.rb +240 -0
  2023. data/lib/purecloudplatformclientv2/models/widget_client_config_v2.rb +176 -0
  2024. data/lib/purecloudplatformclientv2/models/widget_deployment.rb +451 -0
  2025. data/lib/purecloudplatformclientv2/models/widget_deployment_entity_listing.rb +253 -0
  2026. data/lib/purecloudplatformclientv2/models/work_plan.rb +3 -3
  2027. data/lib/purecloudplatformclientv2/models/work_plan_activity.rb +3 -3
  2028. data/lib/purecloudplatformclientv2/models/work_plan_list_item_response.rb +3 -3
  2029. data/lib/purecloudplatformclientv2/models/work_plan_list_response.rb +3 -3
  2030. data/lib/purecloudplatformclientv2/models/work_plan_reference.rb +3 -3
  2031. data/lib/purecloudplatformclientv2/models/work_plan_shift.rb +3 -3
  2032. data/lib/purecloudplatformclientv2/models/workspace.rb +3 -3
  2033. data/lib/purecloudplatformclientv2/models/workspace_create.rb +3 -3
  2034. data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +16 -16
  2035. data/lib/purecloudplatformclientv2/models/workspace_member.rb +3 -3
  2036. data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +16 -16
  2037. data/lib/purecloudplatformclientv2/models/workspace_summary.rb +3 -3
  2038. data/lib/purecloudplatformclientv2/models/wrap_up_code_mapping.rb +3 -3
  2039. data/lib/purecloudplatformclientv2/models/wrap_up_code_reference.rb +3 -3
  2040. data/lib/purecloudplatformclientv2/models/wrapup.rb +3 -3
  2041. data/lib/purecloudplatformclientv2/models/wrapup_code.rb +3 -3
  2042. data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +16 -16
  2043. data/lib/purecloudplatformclientv2/models/writable_dialer_contact.rb +3 -3
  2044. data/lib/purecloudplatformclientv2/models/writable_division.rb +3 -3
  2045. data/lib/purecloudplatformclientv2/models/writable_entity.rb +3 -3
  2046. data/lib/purecloudplatformclientv2/version.rb +4 -4
  2047. metadata +376 -2
@@ -16,10 +16,12 @@ Method | Description
16
16
  [**delete_workforcemanagement_managementunit_week_shorttermforecast**](WorkforceManagementApi.html#delete_workforcemanagement_managementunit_week_shorttermforecast) | Delete a short term forecast
17
17
  [**delete_workforcemanagement_managementunit_workplan**](WorkforceManagementApi.html#delete_workforcemanagement_managementunit_workplan) | Delete a work plan
18
18
  [**get_workforcemanagement_adherence**](WorkforceManagementApi.html#get_workforcemanagement_adherence) | Get a list of UserScheduleAdherence records for the requested users
19
+ [**get_workforcemanagement_adhocmodelingjob**](WorkforceManagementApi.html#get_workforcemanagement_adhocmodelingjob) | Get status of the modeling job
19
20
  [**get_workforcemanagement_managementunit**](WorkforceManagementApi.html#get_workforcemanagement_managementunit) | Get management unit
20
21
  [**get_workforcemanagement_managementunit_activitycode**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_activitycode) | Get an activity code
21
22
  [**get_workforcemanagement_managementunit_activitycodes**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_activitycodes) | Get activity codes
22
23
  [**get_workforcemanagement_managementunit_agent**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_agent) | Get data for agent in the management unit
24
+ [**get_workforcemanagement_managementunit_agent_shifttrades**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_agent_shifttrades) | Gets all the shift trades for a given agent
23
25
  [**get_workforcemanagement_managementunit_intraday_queues**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_intraday_queues) | Get intraday queues for the given date
24
26
  [**get_workforcemanagement_managementunit_scheduling_run**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_scheduling_run) | Gets the status for a specific scheduling run
25
27
  [**get_workforcemanagement_managementunit_scheduling_run_result**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_scheduling_run_result) | Gets the result of a specific scheduling run
@@ -27,21 +29,28 @@ Method | Description
27
29
  [**get_workforcemanagement_managementunit_servicegoalgroup**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_servicegoalgroup) | Get a service goal group
28
30
  [**get_workforcemanagement_managementunit_servicegoalgroups**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_servicegoalgroups) | Get service goal groups
29
31
  [**get_workforcemanagement_managementunit_settings**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_settings) | Get the settings for the requested management unit
32
+ [**get_workforcemanagement_managementunit_shifttrades_matched**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_shifttrades_matched) | Gets a summary of all shift trades in the matched state
33
+ [**get_workforcemanagement_managementunit_shifttrades_users**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_shifttrades_users) | Gets list of users available for whom you can send direct shift trade requests
30
34
  [**get_workforcemanagement_managementunit_user_timeoffrequest**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_user_timeoffrequest) | Get a time off request
31
35
  [**get_workforcemanagement_managementunit_user_timeoffrequests**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_user_timeoffrequests) | Get a list of time off requests for a given user
32
36
  [**get_workforcemanagement_managementunit_users**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_users) | Get users in the management unit
33
37
  [**get_workforcemanagement_managementunit_week_schedule**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_week_schedule) | Get a week schedule
34
38
  [**get_workforcemanagement_managementunit_week_schedule_generationresults**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_week_schedule_generationresults) | Get week schedule generation results
35
39
  [**get_workforcemanagement_managementunit_week_schedules**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_week_schedules) | Get the list of schedules in a week in management unit
40
+ [**get_workforcemanagement_managementunit_week_shifttrades**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_week_shifttrades) | Gets all the shift trades for a given week
36
41
  [**get_workforcemanagement_managementunit_week_shorttermforecast_final**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_week_shorttermforecast_final) | Get the final result of a short term forecast calculation with modifications applied
37
42
  [**get_workforcemanagement_managementunit_week_shorttermforecasts**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_week_shorttermforecasts) | Get short term forecasts
38
43
  [**get_workforcemanagement_managementunit_workplan**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_workplan) | Get a work plan
39
44
  [**get_workforcemanagement_managementunit_workplans**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_workplans) | Get work plans
40
45
  [**get_workforcemanagement_managementunits**](WorkforceManagementApi.html#get_workforcemanagement_managementunits) | Get management units
41
46
  [**get_workforcemanagement_managementunits_divisionviews**](WorkforceManagementApi.html#get_workforcemanagement_managementunits_divisionviews) | Get management units across divisions
47
+ [**get_workforcemanagement_notifications**](WorkforceManagementApi.html#get_workforcemanagement_notifications) | Get a list of notifications for the current user
48
+ [**get_workforcemanagement_schedulingjob**](WorkforceManagementApi.html#get_workforcemanagement_schedulingjob) | Get status of the scheduling job
49
+ [**get_workforcemanagement_shifttrades**](WorkforceManagementApi.html#get_workforcemanagement_shifttrades) | Gets all of my shift trades
42
50
  [**get_workforcemanagement_timeoffrequest**](WorkforceManagementApi.html#get_workforcemanagement_timeoffrequest) | Get a time off request for the current user
43
51
  [**get_workforcemanagement_timeoffrequests**](WorkforceManagementApi.html#get_workforcemanagement_timeoffrequests) | Get a list of time off requests for the current user
44
52
  [**patch_workforcemanagement_managementunit_activitycode**](WorkforceManagementApi.html#patch_workforcemanagement_managementunit_activitycode) | Update an activity code
53
+ [**patch_workforcemanagement_managementunit_agent**](WorkforceManagementApi.html#patch_workforcemanagement_managementunit_agent) | Update agent details
45
54
  [**patch_workforcemanagement_managementunit_scheduling_run**](WorkforceManagementApi.html#patch_workforcemanagement_managementunit_scheduling_run) | Marks a specific scheduling run as applied, allowing a new rescheduling run to be started
46
55
  [**patch_workforcemanagement_managementunit_servicegoalgroup**](WorkforceManagementApi.html#patch_workforcemanagement_managementunit_servicegoalgroup) | Update a service goal group
47
56
  [**patch_workforcemanagement_managementunit_settings**](WorkforceManagementApi.html#patch_workforcemanagement_managementunit_settings) | Patch the settings for the requested management unit
@@ -63,6 +72,10 @@ Method | Description
63
72
  [**post_workforcemanagement_managementunit_week_schedules**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_week_schedules) | Add a schedule for a week in management unit using imported data. Use partial uploads of user schedules if activity count in schedule is greater than 17500
64
73
  [**post_workforcemanagement_managementunit_week_schedules_generate**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_week_schedules_generate) | Generate a week schedule
65
74
  [**post_workforcemanagement_managementunit_week_schedules_partialupload**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_week_schedules_partialupload) | Partial upload of user schedules where activity count is greater than 17500
75
+ [**post_workforcemanagement_managementunit_week_shifttrade_match**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_week_shifttrade_match) | Matches a shift trade. This route can only be called by the receiving agent
76
+ [**post_workforcemanagement_managementunit_week_shifttrade_update**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_week_shifttrade_update) | Updates a shift trade. This route can only be called by the initiating agent
77
+ [**post_workforcemanagement_managementunit_week_shifttrades**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_week_shifttrades) | Adds a shift trade
78
+ [**post_workforcemanagement_managementunit_week_shifttrades_search**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_week_shifttrades_search) | Searches for potential shift trade matches for the current agent
66
79
  [**post_workforcemanagement_managementunit_week_shorttermforecast_copy**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_week_shorttermforecast_copy) | Copy a short term forecast
67
80
  [**post_workforcemanagement_managementunit_week_shorttermforecasts**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_week_shorttermforecasts) | Import a short term forecast
68
81
  [**post_workforcemanagement_managementunit_week_shorttermforecasts_generate**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_week_shorttermforecasts_generate) | Generate a short term forecast
@@ -70,8 +83,10 @@ Method | Description
70
83
  [**post_workforcemanagement_managementunit_workplan_copy**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_workplan_copy) | Create a copy of work plan
71
84
  [**post_workforcemanagement_managementunit_workplans**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_workplans) | Create a new work plan
72
85
  [**post_workforcemanagement_managementunits**](WorkforceManagementApi.html#post_workforcemanagement_managementunits) | Add a management unit
86
+ [**post_workforcemanagement_notifications_update**](WorkforceManagementApi.html#post_workforcemanagement_notifications_update) | Mark a list of notifications as read or unread
73
87
  [**post_workforcemanagement_schedules**](WorkforceManagementApi.html#post_workforcemanagement_schedules) | Get published schedule for the current user
74
88
  [**post_workforcemanagement_timeoffrequests**](WorkforceManagementApi.html#post_workforcemanagement_timeoffrequests) | Create a time off request for the current user
89
+ [**put_workforcemanagement_managementunit_week_shifttrade_state**](WorkforceManagementApi.html#put_workforcemanagement_managementunit_week_shifttrade_state) | Updates a shift trade state
75
90
  {: class="table table-striped"}
76
91
 
77
92
  <a name="delete_workforcemanagement_managementunit"></a>
@@ -617,6 +632,71 @@ Name | Type | Description | Notes
617
632
 
618
633
 
619
634
 
635
+ <a name="get_workforcemanagement_adhocmodelingjob"></a>
636
+
637
+ ## [**ModelingStatusResponse**](ModelingStatusResponse.html) get_workforcemanagement_adhocmodelingjob(job_id)
638
+
639
+
640
+
641
+ Get status of the modeling job
642
+
643
+
644
+
645
+ Wraps GET /api/v2/workforcemanagement/adhocmodelingjobs/{jobId}
646
+
647
+ Requires ANY permissions:
648
+
649
+ * wfm:adhocModel:view
650
+
651
+
652
+ ### Example
653
+ ```{"language":"ruby"}
654
+ # load the gem
655
+ require 'purecloudplatformclientv2'
656
+ # setup authorization
657
+ @secret = ENV['PURECLOUD_SECRET']
658
+ @id = ENV['PURECLOUD_CLIENT_ID']
659
+ environment = "mypurecloud.com"
660
+
661
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
662
+
663
+ PureCloud.configure do |config|
664
+ config.access_token = @authToken
665
+ end
666
+
667
+ api_instance = PureCloud::WorkforceManagementApi.new
668
+
669
+ job_id = "job_id_example" # String | The id of the modeling job
670
+
671
+
672
+ begin
673
+ #Get status of the modeling job
674
+ result = api_instance.get_workforcemanagement_adhocmodelingjob(job_id)
675
+ p result
676
+ rescue PureCloud::ApiError => e
677
+ puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_adhocmodelingjob: #{e}"
678
+ end
679
+ ```
680
+
681
+ ### Parameters
682
+
683
+ Name | Type | Description | Notes
684
+ ------------- | ------------- | ------------- | -------------
685
+ **job_id** | **String**| The id of the modeling job | |
686
+ {: class="table table-striped"}
687
+
688
+
689
+ ### Return type
690
+
691
+ [**ModelingStatusResponse**](ModelingStatusResponse.html)
692
+
693
+ ### HTTP request headers
694
+
695
+ - **Content-Type**: application/json
696
+ - **Accept**: application/json
697
+
698
+
699
+
620
700
  <a name="get_workforcemanagement_managementunit"></a>
621
701
 
622
702
  ## [**ManagementUnit**](ManagementUnit.html) get_workforcemanagement_managementunit(mu_id, opts)
@@ -975,6 +1055,75 @@ Name | Type | Description | Notes
975
1055
 
976
1056
 
977
1057
 
1058
+ <a name="get_workforcemanagement_managementunit_agent_shifttrades"></a>
1059
+
1060
+ ## [**ShiftTradeListResponse**](ShiftTradeListResponse.html) get_workforcemanagement_managementunit_agent_shifttrades(management_unit_id, agent_id)
1061
+
1062
+
1063
+
1064
+ Gets all the shift trades for a given agent
1065
+
1066
+
1067
+
1068
+ Wraps GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/{agentId}/shifttrades
1069
+
1070
+ Requires ANY permissions:
1071
+
1072
+ * wfm:shiftTradeRequest:edit
1073
+ * wfm:shiftTradeRequest:view
1074
+
1075
+
1076
+ ### Example
1077
+ ```{"language":"ruby"}
1078
+ # load the gem
1079
+ require 'purecloudplatformclientv2'
1080
+ # setup authorization
1081
+ @secret = ENV['PURECLOUD_SECRET']
1082
+ @id = ENV['PURECLOUD_CLIENT_ID']
1083
+ environment = "mypurecloud.com"
1084
+
1085
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1086
+
1087
+ PureCloud.configure do |config|
1088
+ config.access_token = @authToken
1089
+ end
1090
+
1091
+ api_instance = PureCloud::WorkforceManagementApi.new
1092
+
1093
+ 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.
1094
+
1095
+ agent_id = "agent_id_example" # String | The agent id
1096
+
1097
+
1098
+ begin
1099
+ #Gets all the shift trades for a given agent
1100
+ result = api_instance.get_workforcemanagement_managementunit_agent_shifttrades(management_unit_id, agent_id)
1101
+ p result
1102
+ rescue PureCloud::ApiError => e
1103
+ puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_agent_shifttrades: #{e}"
1104
+ end
1105
+ ```
1106
+
1107
+ ### Parameters
1108
+
1109
+ Name | Type | Description | Notes
1110
+ ------------- | ------------- | ------------- | -------------
1111
+ **management_unit_id** | **String**| The id of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
1112
+ **agent_id** | **String**| The agent id | |
1113
+ {: class="table table-striped"}
1114
+
1115
+
1116
+ ### Return type
1117
+
1118
+ [**ShiftTradeListResponse**](ShiftTradeListResponse.html)
1119
+
1120
+ ### HTTP request headers
1121
+
1122
+ - **Content-Type**: application/json
1123
+ - **Accept**: application/json
1124
+
1125
+
1126
+
978
1127
  <a name="get_workforcemanagement_managementunit_intraday_queues"></a>
979
1128
 
980
1129
  ## [**WfmIntradayQueueListing**](WfmIntradayQueueListing.html) get_workforcemanagement_managementunit_intraday_queues(mu_id, date)
@@ -1447,6 +1596,137 @@ Name | Type | Description | Notes
1447
1596
 
1448
1597
 
1449
1598
 
1599
+ <a name="get_workforcemanagement_managementunit_shifttrades_matched"></a>
1600
+
1601
+ ## [**ShiftTradeMatchesSummaryResponse**](ShiftTradeMatchesSummaryResponse.html) get_workforcemanagement_managementunit_shifttrades_matched(mu_id)
1602
+
1603
+
1604
+
1605
+ Gets a summary of all shift trades in the matched state
1606
+
1607
+
1608
+
1609
+ Wraps GET /api/v2/workforcemanagement/managementunits/{muId}/shifttrades/matched
1610
+
1611
+ Requires ANY permissions:
1612
+
1613
+ * wfm:shiftTradeRequest:view
1614
+ * wfm:shiftTradeRequest:edit
1615
+
1616
+
1617
+ ### Example
1618
+ ```{"language":"ruby"}
1619
+ # load the gem
1620
+ require 'purecloudplatformclientv2'
1621
+ # setup authorization
1622
+ @secret = ENV['PURECLOUD_SECRET']
1623
+ @id = ENV['PURECLOUD_CLIENT_ID']
1624
+ environment = "mypurecloud.com"
1625
+
1626
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1627
+
1628
+ PureCloud.configure do |config|
1629
+ config.access_token = @authToken
1630
+ end
1631
+
1632
+ api_instance = PureCloud::WorkforceManagementApi.new
1633
+
1634
+ mu_id = "mu_id_example" # String | The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
1635
+
1636
+
1637
+ begin
1638
+ #Gets a summary of all shift trades in the matched state
1639
+ result = api_instance.get_workforcemanagement_managementunit_shifttrades_matched(mu_id)
1640
+ p result
1641
+ rescue PureCloud::ApiError => e
1642
+ puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_shifttrades_matched: #{e}"
1643
+ end
1644
+ ```
1645
+
1646
+ ### Parameters
1647
+
1648
+ Name | Type | Description | Notes
1649
+ ------------- | ------------- | ------------- | -------------
1650
+ **mu_id** | **String**| The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
1651
+ {: class="table table-striped"}
1652
+
1653
+
1654
+ ### Return type
1655
+
1656
+ [**ShiftTradeMatchesSummaryResponse**](ShiftTradeMatchesSummaryResponse.html)
1657
+
1658
+ ### HTTP request headers
1659
+
1660
+ - **Content-Type**: application/json
1661
+ - **Accept**: application/json
1662
+
1663
+
1664
+
1665
+ <a name="get_workforcemanagement_managementunit_shifttrades_users"></a>
1666
+
1667
+ ## [**WfmUserEntityListing**](WfmUserEntityListing.html) get_workforcemanagement_managementunit_shifttrades_users(mu_id)
1668
+
1669
+
1670
+
1671
+ Gets list of users available for whom you can send direct shift trade requests
1672
+
1673
+
1674
+
1675
+ Wraps GET /api/v2/workforcemanagement/managementunits/{muId}/shifttrades/users
1676
+
1677
+ Requires ANY permissions:
1678
+
1679
+ * wfm:agentShiftTradeRequest:participate
1680
+
1681
+
1682
+ ### Example
1683
+ ```{"language":"ruby"}
1684
+ # load the gem
1685
+ require 'purecloudplatformclientv2'
1686
+ # setup authorization
1687
+ @secret = ENV['PURECLOUD_SECRET']
1688
+ @id = ENV['PURECLOUD_CLIENT_ID']
1689
+ environment = "mypurecloud.com"
1690
+
1691
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1692
+
1693
+ PureCloud.configure do |config|
1694
+ config.access_token = @authToken
1695
+ end
1696
+
1697
+ api_instance = PureCloud::WorkforceManagementApi.new
1698
+
1699
+ mu_id = "mu_id_example" # String | The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
1700
+
1701
+
1702
+ begin
1703
+ #Gets list of users available for whom you can send direct shift trade requests
1704
+ result = api_instance.get_workforcemanagement_managementunit_shifttrades_users(mu_id)
1705
+ p result
1706
+ rescue PureCloud::ApiError => e
1707
+ puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_shifttrades_users: #{e}"
1708
+ end
1709
+ ```
1710
+
1711
+ ### Parameters
1712
+
1713
+ Name | Type | Description | Notes
1714
+ ------------- | ------------- | ------------- | -------------
1715
+ **mu_id** | **String**| The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
1716
+ {: class="table table-striped"}
1717
+
1718
+
1719
+ ### Return type
1720
+
1721
+ [**WfmUserEntityListing**](WfmUserEntityListing.html)
1722
+
1723
+ ### HTTP request headers
1724
+
1725
+ - **Content-Type**: application/json
1726
+ - **Accept**: application/json
1727
+
1728
+
1729
+
1450
1730
  <a name="get_workforcemanagement_managementunit_user_timeoffrequest"></a>
1451
1731
 
1452
1732
  ## [**TimeOffRequestResponse**](TimeOffRequestResponse.html) get_workforcemanagement_managementunit_user_timeoffrequest(mu_id, user_id, time_off_request_id)
@@ -1889,22 +2169,22 @@ Name | Type | Description | Notes
1889
2169
 
1890
2170
 
1891
2171
 
1892
- <a name="get_workforcemanagement_managementunit_week_shorttermforecast_final"></a>
2172
+ <a name="get_workforcemanagement_managementunit_week_shifttrades"></a>
1893
2173
 
1894
- ## [**ForecastResultResponse**](ForecastResultResponse.html) get_workforcemanagement_managementunit_week_shorttermforecast_final(management_unit_id, week_date_id, forecast_id, opts)
2174
+ ## [**WeekShiftTradeListResponse**](WeekShiftTradeListResponse.html) get_workforcemanagement_managementunit_week_shifttrades(management_unit_id, week_date_id, opts)
1895
2175
 
1896
2176
 
1897
2177
 
1898
- Get the final result of a short term forecast calculation with modifications applied
2178
+ Gets all the shift trades for a given week
1899
2179
 
1900
2180
 
1901
2181
 
1902
- Wraps GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/final
2182
+ Wraps GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades
1903
2183
 
1904
2184
  Requires ANY permissions:
1905
2185
 
1906
- * wfm:shortTermForecast:administer
1907
- * wfm:shortTermForecast:view
2186
+ * wfm:shiftTradeRequest:view
2187
+ * wfm:shiftTradeRequest:edit
1908
2188
 
1909
2189
 
1910
2190
  ### Example
@@ -1924,22 +2204,20 @@ end
1924
2204
 
1925
2205
  api_instance = PureCloud::WorkforceManagementApi.new
1926
2206
 
1927
- management_unit_id = "management_unit_id_example" # String | The management unit ID of the management unit to which the forecast belongs
1928
-
1929
- week_date_id = "week_date_id_example" # String | The week start date of the forecast in yyyy-MM-dd format
2207
+ management_unit_id = "management_unit_id_example" # String | The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
1930
2208
 
1931
- forecast_id = "forecast_id_example" # String | The ID of the forecast
2209
+ week_date_id = Date.parse("2013-10-20") # Date | The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
1932
2210
 
1933
2211
  opts = {
1934
- force_download_service: true # BOOLEAN | Force the result of this operation to be sent via download service. For testing/app development purposes
2212
+ evaluate_matches: true # BOOLEAN | Whether to evaluate the matches for violations
1935
2213
  }
1936
2214
 
1937
2215
  begin
1938
- #Get the final result of a short term forecast calculation with modifications applied
1939
- result = api_instance.get_workforcemanagement_managementunit_week_shorttermforecast_final(management_unit_id, week_date_id, forecast_id, opts)
2216
+ #Gets all the shift trades for a given week
2217
+ result = api_instance.get_workforcemanagement_managementunit_week_shifttrades(management_unit_id, week_date_id, opts)
1940
2218
  p result
1941
2219
  rescue PureCloud::ApiError => e
1942
- puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_week_shorttermforecast_final: #{e}"
2220
+ puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_week_shifttrades: #{e}"
1943
2221
  end
1944
2222
  ```
1945
2223
 
@@ -1947,16 +2225,15 @@ end
1947
2225
 
1948
2226
  Name | Type | Description | Notes
1949
2227
  ------------- | ------------- | ------------- | -------------
1950
- **management_unit_id** | **String**| The management unit ID of the management unit to which the forecast belongs | |
1951
- **week_date_id** | **String**| The week start date of the forecast in yyyy-MM-dd format | |
1952
- **forecast_id** | **String**| The ID of the forecast | |
1953
- **force_download_service** | **BOOLEAN**| Force the result of this operation to be sent via download service. For testing/app development purposes | [optional] |
2228
+ **management_unit_id** | **String**| The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
2229
+ **week_date_id** | **Date**| The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd | |
2230
+ **evaluate_matches** | **BOOLEAN**| Whether to evaluate the matches for violations | [optional] [default to true] |
1954
2231
  {: class="table table-striped"}
1955
2232
 
1956
2233
 
1957
2234
  ### Return type
1958
2235
 
1959
- [**ForecastResultResponse**](ForecastResultResponse.html)
2236
+ [**WeekShiftTradeListResponse**](WeekShiftTradeListResponse.html)
1960
2237
 
1961
2238
  ### HTTP request headers
1962
2239
 
@@ -1965,21 +2242,97 @@ Name | Type | Description | Notes
1965
2242
 
1966
2243
 
1967
2244
 
1968
- <a name="get_workforcemanagement_managementunit_week_shorttermforecasts"></a>
2245
+ <a name="get_workforcemanagement_managementunit_week_shorttermforecast_final"></a>
1969
2246
 
1970
- ## [**ShortTermForecastListResponse**](ShortTermForecastListResponse.html) get_workforcemanagement_managementunit_week_shorttermforecasts(management_unit_id, week_date_id)
2247
+ ## [**ForecastResultResponse**](ForecastResultResponse.html) get_workforcemanagement_managementunit_week_shorttermforecast_final(management_unit_id, week_date_id, forecast_id, opts)
1971
2248
 
1972
2249
 
1973
2250
 
1974
- Get short term forecasts
2251
+ Get the final result of a short term forecast calculation with modifications applied
1975
2252
 
1976
- Use \"recent\" for the `weekDateId` path parameter to fetch all forecasts for +/- 26 weeks from the current date
1977
2253
 
1978
- Wraps GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts
2254
+
2255
+ Wraps GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/final
1979
2256
 
1980
2257
  Requires ANY permissions:
1981
2258
 
1982
- * wfm:schedule:generate
2259
+ * wfm:shortTermForecast:administer
2260
+ * wfm:shortTermForecast:view
2261
+
2262
+
2263
+ ### Example
2264
+ ```{"language":"ruby"}
2265
+ # load the gem
2266
+ require 'purecloudplatformclientv2'
2267
+ # setup authorization
2268
+ @secret = ENV['PURECLOUD_SECRET']
2269
+ @id = ENV['PURECLOUD_CLIENT_ID']
2270
+ environment = "mypurecloud.com"
2271
+
2272
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
2273
+
2274
+ PureCloud.configure do |config|
2275
+ config.access_token = @authToken
2276
+ end
2277
+
2278
+ api_instance = PureCloud::WorkforceManagementApi.new
2279
+
2280
+ management_unit_id = "management_unit_id_example" # String | The management unit ID of the management unit to which the forecast belongs
2281
+
2282
+ week_date_id = "week_date_id_example" # String | The week start date of the forecast in yyyy-MM-dd format
2283
+
2284
+ forecast_id = "forecast_id_example" # String | The ID of the forecast
2285
+
2286
+ opts = {
2287
+ force_download_service: true # BOOLEAN | Force the result of this operation to be sent via download service. For testing/app development purposes
2288
+ }
2289
+
2290
+ begin
2291
+ #Get the final result of a short term forecast calculation with modifications applied
2292
+ result = api_instance.get_workforcemanagement_managementunit_week_shorttermforecast_final(management_unit_id, week_date_id, forecast_id, opts)
2293
+ p result
2294
+ rescue PureCloud::ApiError => e
2295
+ puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_week_shorttermforecast_final: #{e}"
2296
+ end
2297
+ ```
2298
+
2299
+ ### Parameters
2300
+
2301
+ Name | Type | Description | Notes
2302
+ ------------- | ------------- | ------------- | -------------
2303
+ **management_unit_id** | **String**| The management unit ID of the management unit to which the forecast belongs | |
2304
+ **week_date_id** | **String**| The week start date of the forecast in yyyy-MM-dd format | |
2305
+ **forecast_id** | **String**| The ID of the forecast | |
2306
+ **force_download_service** | **BOOLEAN**| Force the result of this operation to be sent via download service. For testing/app development purposes | [optional] |
2307
+ {: class="table table-striped"}
2308
+
2309
+
2310
+ ### Return type
2311
+
2312
+ [**ForecastResultResponse**](ForecastResultResponse.html)
2313
+
2314
+ ### HTTP request headers
2315
+
2316
+ - **Content-Type**: application/json
2317
+ - **Accept**: application/json
2318
+
2319
+
2320
+
2321
+ <a name="get_workforcemanagement_managementunit_week_shorttermforecasts"></a>
2322
+
2323
+ ## [**ShortTermForecastListResponse**](ShortTermForecastListResponse.html) get_workforcemanagement_managementunit_week_shorttermforecasts(management_unit_id, week_date_id)
2324
+
2325
+
2326
+
2327
+ Get short term forecasts
2328
+
2329
+ Use \"recent\" for the `weekDateId` path parameter to fetch all forecasts for +/- 26 weeks from the current date
2330
+
2331
+ Wraps GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts
2332
+
2333
+ Requires ANY permissions:
2334
+
2335
+ * wfm:schedule:generate
1983
2336
  * wfm:shortTermForecast:administer
1984
2337
  * wfm:shortTermForecast:view
1985
2338
 
@@ -2238,7 +2591,7 @@ Name | Type | Description | Notes
2238
2591
  **page_size** | **Integer**| | [optional] |
2239
2592
  **page_number** | **Integer**| | [optional] |
2240
2593
  **expand** | **String**| | [optional] <br />**Values**: details |
2241
- **feature** | **String**| | [optional] <br />**Values**: AgentSchedule, AgentTimeOffRequest, ActivityCodes, Agents, HistoricalAdherence, IntradayMonitoring, ManagementUnits, RealTimeAdherence, Schedules, ServiceGoalGroups, ShortTermForecasts, TimeOffRequests, WorkPlans |
2594
+ **feature** | **String**| | [optional] <br />**Values**: AgentSchedule, AgentTimeOffRequest, ActivityCodes, Agents, HistoricalAdherence, IntradayMonitoring, ManagementUnits, RealTimeAdherence, Schedules, ServiceGoalGroups, ShiftTrading, ShortTermForecasts, TimeOffRequests, WorkPlans |
2242
2595
  **division_id** | **String**| | [optional] |
2243
2596
  {: class="table table-striped"}
2244
2597
 
@@ -2320,22 +2673,20 @@ Name | Type | Description | Notes
2320
2673
 
2321
2674
 
2322
2675
 
2323
- <a name="get_workforcemanagement_timeoffrequest"></a>
2676
+ <a name="get_workforcemanagement_notifications"></a>
2324
2677
 
2325
- ## [**TimeOffRequestResponse**](TimeOffRequestResponse.html) get_workforcemanagement_timeoffrequest(time_off_request_id)
2678
+ ## [**NotificationsResponse**](NotificationsResponse.html) get_workforcemanagement_notifications
2326
2679
 
2327
2680
 
2328
2681
 
2329
- Get a time off request for the current user
2682
+ Get a list of notifications for the current user
2330
2683
 
2331
2684
 
2332
2685
 
2333
- Wraps GET /api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}
2686
+ Wraps GET /api/v2/workforcemanagement/notifications
2334
2687
 
2335
- Requires ANY permissions:
2688
+ Requires NO permissions:
2336
2689
 
2337
- * wfm:agentSchedule:view
2338
- * wfm:agentTimeOffRequest:submit
2339
2690
 
2340
2691
 
2341
2692
  ### Example
@@ -2355,29 +2706,23 @@ end
2355
2706
 
2356
2707
  api_instance = PureCloud::WorkforceManagementApi.new
2357
2708
 
2358
- time_off_request_id = "time_off_request_id_example" # String | Time Off Request Id
2359
-
2360
-
2361
2709
  begin
2362
- #Get a time off request for the current user
2363
- result = api_instance.get_workforcemanagement_timeoffrequest(time_off_request_id)
2710
+ #Get a list of notifications for the current user
2711
+ result = api_instance.get_workforcemanagement_notifications
2364
2712
  p result
2365
2713
  rescue PureCloud::ApiError => e
2366
- puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_timeoffrequest: #{e}"
2714
+ puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_notifications: #{e}"
2367
2715
  end
2368
2716
  ```
2369
2717
 
2370
2718
  ### Parameters
2371
-
2372
- Name | Type | Description | Notes
2373
- ------------- | ------------- | ------------- | -------------
2374
- **time_off_request_id** | **String**| Time Off Request Id | |
2719
+ This endpoint does not need any parameter.
2375
2720
  {: class="table table-striped"}
2376
2721
 
2377
2722
 
2378
2723
  ### Return type
2379
2724
 
2380
- [**TimeOffRequestResponse**](TimeOffRequestResponse.html)
2725
+ [**NotificationsResponse**](NotificationsResponse.html)
2381
2726
 
2382
2727
  ### HTTP request headers
2383
2728
 
@@ -2386,22 +2731,21 @@ Name | Type | Description | Notes
2386
2731
 
2387
2732
 
2388
2733
 
2389
- <a name="get_workforcemanagement_timeoffrequests"></a>
2734
+ <a name="get_workforcemanagement_schedulingjob"></a>
2390
2735
 
2391
- ## [**TimeOffRequestList**](TimeOffRequestList.html) get_workforcemanagement_timeoffrequests(opts)
2736
+ ## [**SchedulingStatusResponse**](SchedulingStatusResponse.html) get_workforcemanagement_schedulingjob(job_id)
2392
2737
 
2393
2738
 
2394
2739
 
2395
- Get a list of time off requests for the current user
2740
+ Get status of the scheduling job
2396
2741
 
2397
2742
 
2398
2743
 
2399
- Wraps GET /api/v2/workforcemanagement/timeoffrequests
2744
+ Wraps GET /api/v2/workforcemanagement/schedulingjobs/{jobId}
2400
2745
 
2401
2746
  Requires ANY permissions:
2402
2747
 
2403
- * wfm:agentSchedule:view
2404
- * wfm:agentTimeOffRequest:submit
2748
+ * wfm:schedulingrequest:view
2405
2749
 
2406
2750
 
2407
2751
  ### Example
@@ -2421,16 +2765,15 @@ end
2421
2765
 
2422
2766
  api_instance = PureCloud::WorkforceManagementApi.new
2423
2767
 
2424
- opts = {
2425
- recently_reviewed: false # BOOLEAN | Limit results to requests that have been reviewed within the preceding 30 days
2426
- }
2768
+ job_id = "job_id_example" # String | The id of the scheduling job
2769
+
2427
2770
 
2428
2771
  begin
2429
- #Get a list of time off requests for the current user
2430
- result = api_instance.get_workforcemanagement_timeoffrequests(opts)
2772
+ #Get status of the scheduling job
2773
+ result = api_instance.get_workforcemanagement_schedulingjob(job_id)
2431
2774
  p result
2432
2775
  rescue PureCloud::ApiError => e
2433
- puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_timeoffrequests: #{e}"
2776
+ puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_schedulingjob: #{e}"
2434
2777
  end
2435
2778
  ```
2436
2779
 
@@ -2438,13 +2781,13 @@ end
2438
2781
 
2439
2782
  Name | Type | Description | Notes
2440
2783
  ------------- | ------------- | ------------- | -------------
2441
- **recently_reviewed** | **BOOLEAN**| Limit results to requests that have been reviewed within the preceding 30 days | [optional] [default to false] |
2784
+ **job_id** | **String**| The id of the scheduling job | |
2442
2785
  {: class="table table-striped"}
2443
2786
 
2444
2787
 
2445
2788
  ### Return type
2446
2789
 
2447
- [**TimeOffRequestList**](TimeOffRequestList.html)
2790
+ [**SchedulingStatusResponse**](SchedulingStatusResponse.html)
2448
2791
 
2449
2792
  ### HTTP request headers
2450
2793
 
@@ -2453,22 +2796,23 @@ Name | Type | Description | Notes
2453
2796
 
2454
2797
 
2455
2798
 
2456
- <a name="patch_workforcemanagement_managementunit_activitycode"></a>
2799
+ <a name="get_workforcemanagement_shifttrades"></a>
2457
2800
 
2458
- ## [**ActivityCode**](ActivityCode.html) patch_workforcemanagement_managementunit_activitycode(mu_id, ac_id, opts)
2801
+ ## [**ShiftTradeListResponse**](ShiftTradeListResponse.html) get_workforcemanagement_shifttrades
2459
2802
 
2460
2803
 
2461
2804
 
2462
- Update an activity code
2805
+ Gets all of my shift trades
2463
2806
 
2464
2807
 
2465
2808
 
2466
- Wraps PATCH /api/v2/workforcemanagement/managementunits/{muId}/activitycodes/{acId}
2809
+ Wraps GET /api/v2/workforcemanagement/shifttrades
2467
2810
 
2468
2811
  Requires ANY permissions:
2469
2812
 
2470
- * wfm:activityCode:administer
2471
- * wfm:activityCode:edit
2813
+ * wfm:shiftTradeRequest:edit
2814
+ * wfm:shiftTradeRequest:view
2815
+ * wfm:agentShiftTradeRequest:participate
2472
2816
 
2473
2817
 
2474
2818
  ### Example
@@ -2488,36 +2832,23 @@ end
2488
2832
 
2489
2833
  api_instance = PureCloud::WorkforceManagementApi.new
2490
2834
 
2491
- mu_id = "mu_id_example" # String | The ID of the management unit, or 'mine' for the management unit of the logged-in user.
2492
-
2493
- ac_id = "ac_id_example" # String | The ID of the activity code to update
2494
-
2495
- opts = {
2496
- body: PureCloud::UpdateActivityCodeRequest.new # UpdateActivityCodeRequest | body
2497
- }
2498
-
2499
2835
  begin
2500
- #Update an activity code
2501
- result = api_instance.patch_workforcemanagement_managementunit_activitycode(mu_id, ac_id, opts)
2836
+ #Gets all of my shift trades
2837
+ result = api_instance.get_workforcemanagement_shifttrades
2502
2838
  p result
2503
2839
  rescue PureCloud::ApiError => e
2504
- puts "Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit_activitycode: #{e}"
2840
+ puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_shifttrades: #{e}"
2505
2841
  end
2506
2842
  ```
2507
2843
 
2508
2844
  ### Parameters
2509
-
2510
- Name | Type | Description | Notes
2511
- ------------- | ------------- | ------------- | -------------
2512
- **mu_id** | **String**| The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
2513
- **ac_id** | **String**| The ID of the activity code to update | |
2514
- **body** | [**UpdateActivityCodeRequest**](UpdateActivityCodeRequest.html)| body | [optional] |
2845
+ This endpoint does not need any parameter.
2515
2846
  {: class="table table-striped"}
2516
2847
 
2517
2848
 
2518
2849
  ### Return type
2519
2850
 
2520
- [**ActivityCode**](ActivityCode.html)
2851
+ [**ShiftTradeListResponse**](ShiftTradeListResponse.html)
2521
2852
 
2522
2853
  ### HTTP request headers
2523
2854
 
@@ -2526,21 +2857,22 @@ Name | Type | Description | Notes
2526
2857
 
2527
2858
 
2528
2859
 
2529
- <a name="patch_workforcemanagement_managementunit_scheduling_run"></a>
2860
+ <a name="get_workforcemanagement_timeoffrequest"></a>
2530
2861
 
2531
- ## [**RescheduleResult**](RescheduleResult.html) patch_workforcemanagement_managementunit_scheduling_run(management_unit_id, run_id, opts)
2862
+ ## [**TimeOffRequestResponse**](TimeOffRequestResponse.html) get_workforcemanagement_timeoffrequest(time_off_request_id)
2532
2863
 
2533
2864
 
2534
2865
 
2535
- Marks a specific scheduling run as applied, allowing a new rescheduling run to be started
2866
+ Get a time off request for the current user
2536
2867
 
2537
2868
 
2538
2869
 
2539
- Wraps PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/scheduling/runs/{runId}
2870
+ Wraps GET /api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}
2540
2871
 
2541
2872
  Requires ANY permissions:
2542
2873
 
2543
- * wfm:schedule:generate
2874
+ * wfm:agentSchedule:view
2875
+ * wfm:agentTimeOffRequest:submit
2544
2876
 
2545
2877
 
2546
2878
  ### Example
@@ -2560,20 +2892,15 @@ end
2560
2892
 
2561
2893
  api_instance = PureCloud::WorkforceManagementApi.new
2562
2894
 
2563
- management_unit_id = "management_unit_id_example" # String | The ID of the management unit.
2564
-
2565
- run_id = "run_id_example" # String | The ID of the schedule run
2895
+ time_off_request_id = "time_off_request_id_example" # String | Time Off Request Id
2566
2896
 
2567
- opts = {
2568
- body: PureCloud::UpdateSchedulingRunRequest.new # UpdateSchedulingRunRequest | body
2569
- }
2570
2897
 
2571
2898
  begin
2572
- #Marks a specific scheduling run as applied, allowing a new rescheduling run to be started
2573
- result = api_instance.patch_workforcemanagement_managementunit_scheduling_run(management_unit_id, run_id, opts)
2899
+ #Get a time off request for the current user
2900
+ result = api_instance.get_workforcemanagement_timeoffrequest(time_off_request_id)
2574
2901
  p result
2575
2902
  rescue PureCloud::ApiError => e
2576
- puts "Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit_scheduling_run: #{e}"
2903
+ puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_timeoffrequest: #{e}"
2577
2904
  end
2578
2905
  ```
2579
2906
 
@@ -2581,15 +2908,13 @@ end
2581
2908
 
2582
2909
  Name | Type | Description | Notes
2583
2910
  ------------- | ------------- | ------------- | -------------
2584
- **management_unit_id** | **String**| The ID of the management unit. | |
2585
- **run_id** | **String**| The ID of the schedule run | |
2586
- **body** | [**UpdateSchedulingRunRequest**](UpdateSchedulingRunRequest.html)| body | [optional] |
2911
+ **time_off_request_id** | **String**| Time Off Request Id | |
2587
2912
  {: class="table table-striped"}
2588
2913
 
2589
2914
 
2590
2915
  ### Return type
2591
2916
 
2592
- [**RescheduleResult**](RescheduleResult.html)
2917
+ [**TimeOffRequestResponse**](TimeOffRequestResponse.html)
2593
2918
 
2594
2919
  ### HTTP request headers
2595
2920
 
@@ -2598,22 +2923,22 @@ Name | Type | Description | Notes
2598
2923
 
2599
2924
 
2600
2925
 
2601
- <a name="patch_workforcemanagement_managementunit_servicegoalgroup"></a>
2926
+ <a name="get_workforcemanagement_timeoffrequests"></a>
2602
2927
 
2603
- ## [**ServiceGoalGroup**](ServiceGoalGroup.html) patch_workforcemanagement_managementunit_servicegoalgroup(management_unit_id, service_goal_group_id, opts)
2928
+ ## [**TimeOffRequestList**](TimeOffRequestList.html) get_workforcemanagement_timeoffrequests(opts)
2604
2929
 
2605
2930
 
2606
2931
 
2607
- Update a service goal group
2932
+ Get a list of time off requests for the current user
2608
2933
 
2609
2934
 
2610
2935
 
2611
- Wraps PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups/{serviceGoalGroupId}
2936
+ Wraps GET /api/v2/workforcemanagement/timeoffrequests
2612
2937
 
2613
2938
  Requires ANY permissions:
2614
2939
 
2615
- * wfm:serviceGoalGroup:administer
2616
- * wfm:serviceGoalGroup:edit
2940
+ * wfm:agentSchedule:view
2941
+ * wfm:agentTimeOffRequest:submit
2617
2942
 
2618
2943
 
2619
2944
  ### Example
@@ -2633,20 +2958,16 @@ end
2633
2958
 
2634
2959
  api_instance = PureCloud::WorkforceManagementApi.new
2635
2960
 
2636
- 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.
2637
-
2638
- service_goal_group_id = "service_goal_group_id_example" # String | The ID of the service goal group to update
2639
-
2640
2961
  opts = {
2641
- body: PureCloud::ServiceGoalGroup.new # ServiceGoalGroup | body
2962
+ recently_reviewed: false # BOOLEAN | Limit results to requests that have been reviewed within the preceding 30 days
2642
2963
  }
2643
2964
 
2644
2965
  begin
2645
- #Update a service goal group
2646
- result = api_instance.patch_workforcemanagement_managementunit_servicegoalgroup(management_unit_id, service_goal_group_id, opts)
2966
+ #Get a list of time off requests for the current user
2967
+ result = api_instance.get_workforcemanagement_timeoffrequests(opts)
2647
2968
  p result
2648
2969
  rescue PureCloud::ApiError => e
2649
- puts "Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit_servicegoalgroup: #{e}"
2970
+ puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_timeoffrequests: #{e}"
2650
2971
  end
2651
2972
  ```
2652
2973
 
@@ -2654,15 +2975,13 @@ end
2654
2975
 
2655
2976
  Name | Type | Description | Notes
2656
2977
  ------------- | ------------- | ------------- | -------------
2657
- **management_unit_id** | **String**| The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
2658
- **service_goal_group_id** | **String**| The ID of the service goal group to update | |
2659
- **body** | [**ServiceGoalGroup**](ServiceGoalGroup.html)| body | [optional] |
2978
+ **recently_reviewed** | **BOOLEAN**| Limit results to requests that have been reviewed within the preceding 30 days | [optional] [default to false] |
2660
2979
  {: class="table table-striped"}
2661
2980
 
2662
2981
 
2663
2982
  ### Return type
2664
2983
 
2665
- [**ServiceGoalGroup**](ServiceGoalGroup.html)
2984
+ [**TimeOffRequestList**](TimeOffRequestList.html)
2666
2985
 
2667
2986
  ### HTTP request headers
2668
2987
 
@@ -2671,22 +2990,22 @@ Name | Type | Description | Notes
2671
2990
 
2672
2991
 
2673
2992
 
2674
- <a name="patch_workforcemanagement_managementunit_settings"></a>
2993
+ <a name="patch_workforcemanagement_managementunit_activitycode"></a>
2675
2994
 
2676
- ## [**ManagementUnitSettings**](ManagementUnitSettings.html) patch_workforcemanagement_managementunit_settings(mu_id, opts)
2995
+ ## [**ActivityCode**](ActivityCode.html) patch_workforcemanagement_managementunit_activitycode(mu_id, ac_id, opts)
2677
2996
 
2678
2997
 
2679
2998
 
2680
- Patch the settings for the requested management unit
2999
+ Update an activity code
2681
3000
 
2682
3001
 
2683
3002
 
2684
- Wraps PATCH /api/v2/workforcemanagement/managementunits/{muId}/settings
3003
+ Wraps PATCH /api/v2/workforcemanagement/managementunits/{muId}/activitycodes/{acId}
2685
3004
 
2686
3005
  Requires ANY permissions:
2687
3006
 
2688
- * wfm:managementUnit:administer
2689
- * wfm:managementUnit:edit
3007
+ * wfm:activityCode:administer
3008
+ * wfm:activityCode:edit
2690
3009
 
2691
3010
 
2692
3011
  ### Example
@@ -2706,18 +3025,20 @@ end
2706
3025
 
2707
3026
  api_instance = PureCloud::WorkforceManagementApi.new
2708
3027
 
2709
- mu_id = "mu_id_example" # String | The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
3028
+ mu_id = "mu_id_example" # String | The ID of the management unit, or 'mine' for the management unit of the logged-in user.
3029
+
3030
+ ac_id = "ac_id_example" # String | The ID of the activity code to update
2710
3031
 
2711
3032
  opts = {
2712
- body: PureCloud::ManagementUnitSettings.new # ManagementUnitSettings | config
3033
+ body: PureCloud::UpdateActivityCodeRequest.new # UpdateActivityCodeRequest | body
2713
3034
  }
2714
3035
 
2715
3036
  begin
2716
- #Patch the settings for the requested management unit
2717
- result = api_instance.patch_workforcemanagement_managementunit_settings(mu_id, opts)
3037
+ #Update an activity code
3038
+ result = api_instance.patch_workforcemanagement_managementunit_activitycode(mu_id, ac_id, opts)
2718
3039
  p result
2719
3040
  rescue PureCloud::ApiError => e
2720
- puts "Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit_settings: #{e}"
3041
+ puts "Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit_activitycode: #{e}"
2721
3042
  end
2722
3043
  ```
2723
3044
 
@@ -2725,14 +3046,15 @@ end
2725
3046
 
2726
3047
  Name | Type | Description | Notes
2727
3048
  ------------- | ------------- | ------------- | -------------
2728
- **mu_id** | **String**| The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
2729
- **body** | [**ManagementUnitSettings**](ManagementUnitSettings.html)| config | [optional] |
3049
+ **mu_id** | **String**| The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
3050
+ **ac_id** | **String**| The ID of the activity code to update | |
3051
+ **body** | [**UpdateActivityCodeRequest**](UpdateActivityCodeRequest.html)| body | [optional] |
2730
3052
  {: class="table table-striped"}
2731
3053
 
2732
3054
 
2733
3055
  ### Return type
2734
3056
 
2735
- [**ManagementUnitSettings**](ManagementUnitSettings.html)
3057
+ [**ActivityCode**](ActivityCode.html)
2736
3058
 
2737
3059
  ### HTTP request headers
2738
3060
 
@@ -2741,22 +3063,20 @@ Name | Type | Description | Notes
2741
3063
 
2742
3064
 
2743
3065
 
2744
- <a name="patch_workforcemanagement_managementunit_user_timeoffrequest"></a>
3066
+ <a name="patch_workforcemanagement_managementunit_agent"></a>
2745
3067
 
2746
- ## [**TimeOffRequestResponse**](TimeOffRequestResponse.html) patch_workforcemanagement_managementunit_user_timeoffrequest(mu_id, user_id, time_off_request_id, opts)
3068
+ ## patch_workforcemanagement_managementunit_agent(management_unit_id, agent_id, body)
2747
3069
 
2748
3070
 
2749
3071
 
2750
- Update a time off request
3072
+ Update agent details
2751
3073
 
2752
3074
 
2753
3075
 
2754
- Wraps PATCH /api/v2/workforcemanagement/managementunits/{muId}/users/{userId}/timeoffrequests/{timeOffRequestId}
3076
+ Wraps PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/{agentId}
2755
3077
 
2756
- Requires ANY permissions:
3078
+ Requires NO permissions:
2757
3079
 
2758
- * wfm:timeOffRequest:administer
2759
- * wfm:timeOffRequest:edit
2760
3080
 
2761
3081
 
2762
3082
  ### Example
@@ -2776,22 +3096,18 @@ end
2776
3096
 
2777
3097
  api_instance = PureCloud::WorkforceManagementApi.new
2778
3098
 
2779
- mu_id = "mu_id_example" # String | The muId of the management unit, or 'mine' for the management unit of the logged-in user.
3099
+ 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.
2780
3100
 
2781
- user_id = "user_id_example" # String | The id of the user the requested time off request belongs to
3101
+ agent_id = "agent_id_example" # String | The agent id
2782
3102
 
2783
- time_off_request_id = "time_off_request_id_example" # String | The id of the time off request to update
3103
+ body = PureCloud::UpdateAgentRequest.new # UpdateAgentRequest | The request body
2784
3104
 
2785
- opts = {
2786
- body: PureCloud::AdminTimeOffRequestPatch.new # AdminTimeOffRequestPatch | body
2787
- }
2788
3105
 
2789
3106
  begin
2790
- #Update a time off request
2791
- result = api_instance.patch_workforcemanagement_managementunit_user_timeoffrequest(mu_id, user_id, time_off_request_id, opts)
2792
- p result
3107
+ #Update agent details
3108
+ api_instance.patch_workforcemanagement_managementunit_agent(management_unit_id, agent_id, body)
2793
3109
  rescue PureCloud::ApiError => e
2794
- puts "Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit_user_timeoffrequest: #{e}"
3110
+ puts "Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit_agent: #{e}"
2795
3111
  end
2796
3112
  ```
2797
3113
 
@@ -2799,16 +3115,15 @@ end
2799
3115
 
2800
3116
  Name | Type | Description | Notes
2801
3117
  ------------- | ------------- | ------------- | -------------
2802
- **mu_id** | **String**| The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
2803
- **user_id** | **String**| The id of the user the requested time off request belongs to | |
2804
- **time_off_request_id** | **String**| The id of the time off request to update | |
2805
- **body** | [**AdminTimeOffRequestPatch**](AdminTimeOffRequestPatch.html)| body | [optional] |
3118
+ **management_unit_id** | **String**| The id of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
3119
+ **agent_id** | **String**| The agent id | |
3120
+ **body** | [**UpdateAgentRequest**](UpdateAgentRequest.html)| The request body | |
2806
3121
  {: class="table table-striped"}
2807
3122
 
2808
3123
 
2809
3124
  ### Return type
2810
3125
 
2811
- [**TimeOffRequestResponse**](TimeOffRequestResponse.html)
3126
+ nil (empty response body)
2812
3127
 
2813
3128
  ### HTTP request headers
2814
3129
 
@@ -2817,22 +3132,21 @@ Name | Type | Description | Notes
2817
3132
 
2818
3133
 
2819
3134
 
2820
- <a name="patch_workforcemanagement_managementunit_week_schedule"></a>
3135
+ <a name="patch_workforcemanagement_managementunit_scheduling_run"></a>
2821
3136
 
2822
- ## [**AsyncWeekScheduleResponse**](AsyncWeekScheduleResponse.html) patch_workforcemanagement_managementunit_week_schedule(management_unit_id, week_id, schedule_id, opts)
3137
+ ## [**RescheduleResult**](RescheduleResult.html) patch_workforcemanagement_managementunit_scheduling_run(management_unit_id, run_id, opts)
2823
3138
 
2824
3139
 
2825
3140
 
2826
- Update a week schedule
3141
+ Marks a specific scheduling run as applied, allowing a new rescheduling run to be started
2827
3142
 
2828
3143
 
2829
3144
 
2830
- Wraps PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}
3145
+ Wraps PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/scheduling/runs/{runId}
2831
3146
 
2832
3147
  Requires ANY permissions:
2833
3148
 
2834
- * wfm:schedule:administer
2835
- * wfm:schedule:edit
3149
+ * wfm:schedule:generate
2836
3150
 
2837
3151
 
2838
3152
  ### Example
@@ -2852,24 +3166,20 @@ end
2852
3166
 
2853
3167
  api_instance = PureCloud::WorkforceManagementApi.new
2854
3168
 
2855
- 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.
2856
-
2857
- week_id = "week_id_example" # String | First day of schedule week in yyyy-MM-dd format.
3169
+ management_unit_id = "management_unit_id_example" # String | The ID of the management unit.
2858
3170
 
2859
- schedule_id = "schedule_id_example" # String | The ID of the schedule to update. Use partial uploads of user schedules if activity count in schedule is greater than 17500
3171
+ run_id = "run_id_example" # String | The ID of the schedule run
2860
3172
 
2861
3173
  opts = {
2862
- force_async: true, # BOOLEAN | Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
2863
- force_download_service: true, # BOOLEAN | Force the result of this operation to be sent via download service. For testing/app development purposes
2864
- body: PureCloud::UpdateWeekScheduleRequest.new # UpdateWeekScheduleRequest | body
3174
+ body: PureCloud::UpdateSchedulingRunRequest.new # UpdateSchedulingRunRequest | body
2865
3175
  }
2866
3176
 
2867
3177
  begin
2868
- #Update a week schedule
2869
- result = api_instance.patch_workforcemanagement_managementunit_week_schedule(management_unit_id, week_id, schedule_id, opts)
3178
+ #Marks a specific scheduling run as applied, allowing a new rescheduling run to be started
3179
+ result = api_instance.patch_workforcemanagement_managementunit_scheduling_run(management_unit_id, run_id, opts)
2870
3180
  p result
2871
3181
  rescue PureCloud::ApiError => e
2872
- puts "Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit_week_schedule: #{e}"
3182
+ puts "Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit_scheduling_run: #{e}"
2873
3183
  end
2874
3184
  ```
2875
3185
 
@@ -2877,18 +3187,15 @@ end
2877
3187
 
2878
3188
  Name | Type | Description | Notes
2879
3189
  ------------- | ------------- | ------------- | -------------
2880
- **management_unit_id** | **String**| The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
2881
- **week_id** | **String**| First day of schedule week in yyyy-MM-dd format. | |
2882
- **schedule_id** | **String**| The ID of the schedule to update. Use partial uploads of user schedules if activity count in schedule is greater than 17500 | |
2883
- **force_async** | **BOOLEAN**| Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes | [optional] |
2884
- **force_download_service** | **BOOLEAN**| Force the result of this operation to be sent via download service. For testing/app development purposes | [optional] |
2885
- **body** | [**UpdateWeekScheduleRequest**](UpdateWeekScheduleRequest.html)| body | [optional] |
3190
+ **management_unit_id** | **String**| The ID of the management unit. | |
3191
+ **run_id** | **String**| The ID of the schedule run | |
3192
+ **body** | [**UpdateSchedulingRunRequest**](UpdateSchedulingRunRequest.html)| body | [optional] |
2886
3193
  {: class="table table-striped"}
2887
3194
 
2888
3195
 
2889
3196
  ### Return type
2890
3197
 
2891
- [**AsyncWeekScheduleResponse**](AsyncWeekScheduleResponse.html)
3198
+ [**RescheduleResult**](RescheduleResult.html)
2892
3199
 
2893
3200
  ### HTTP request headers
2894
3201
 
@@ -2897,22 +3204,22 @@ Name | Type | Description | Notes
2897
3204
 
2898
3205
 
2899
3206
 
2900
- <a name="patch_workforcemanagement_managementunit_workplan"></a>
3207
+ <a name="patch_workforcemanagement_managementunit_servicegoalgroup"></a>
2901
3208
 
2902
- ## [**WorkPlan**](WorkPlan.html) patch_workforcemanagement_managementunit_workplan(management_unit_id, work_plan_id, opts)
3209
+ ## [**ServiceGoalGroup**](ServiceGoalGroup.html) patch_workforcemanagement_managementunit_servicegoalgroup(management_unit_id, service_goal_group_id, opts)
2903
3210
 
2904
3211
 
2905
3212
 
2906
- Update a work plan
3213
+ Update a service goal group
2907
3214
 
2908
3215
 
2909
3216
 
2910
- Wraps PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}
3217
+ Wraps PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups/{serviceGoalGroupId}
2911
3218
 
2912
3219
  Requires ANY permissions:
2913
3220
 
2914
- * wfm:workPlan:administer
2915
- * wfm:workPlan:edit
3221
+ * wfm:serviceGoalGroup:administer
3222
+ * wfm:serviceGoalGroup:edit
2916
3223
 
2917
3224
 
2918
3225
  ### Example
@@ -2934,18 +3241,18 @@ api_instance = PureCloud::WorkforceManagementApi.new
2934
3241
 
2935
3242
  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.
2936
3243
 
2937
- work_plan_id = "work_plan_id_example" # String | The ID of the work plan to update
3244
+ service_goal_group_id = "service_goal_group_id_example" # String | The ID of the service goal group to update
2938
3245
 
2939
3246
  opts = {
2940
- body: PureCloud::WorkPlan.new # WorkPlan | body
3247
+ body: PureCloud::ServiceGoalGroup.new # ServiceGoalGroup | body
2941
3248
  }
2942
3249
 
2943
3250
  begin
2944
- #Update a work plan
2945
- result = api_instance.patch_workforcemanagement_managementunit_workplan(management_unit_id, work_plan_id, opts)
3251
+ #Update a service goal group
3252
+ result = api_instance.patch_workforcemanagement_managementunit_servicegoalgroup(management_unit_id, service_goal_group_id, opts)
2946
3253
  p result
2947
3254
  rescue PureCloud::ApiError => e
2948
- puts "Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit_workplan: #{e}"
3255
+ puts "Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit_servicegoalgroup: #{e}"
2949
3256
  end
2950
3257
  ```
2951
3258
 
@@ -2954,14 +3261,14 @@ end
2954
3261
  Name | Type | Description | Notes
2955
3262
  ------------- | ------------- | ------------- | -------------
2956
3263
  **management_unit_id** | **String**| The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
2957
- **work_plan_id** | **String**| The ID of the work plan to update | |
2958
- **body** | [**WorkPlan**](WorkPlan.html)| body | [optional] |
3264
+ **service_goal_group_id** | **String**| The ID of the service goal group to update | |
3265
+ **body** | [**ServiceGoalGroup**](ServiceGoalGroup.html)| body | [optional] |
2959
3266
  {: class="table table-striped"}
2960
3267
 
2961
3268
 
2962
3269
  ### Return type
2963
3270
 
2964
- [**WorkPlan**](WorkPlan.html)
3271
+ [**ServiceGoalGroup**](ServiceGoalGroup.html)
2965
3272
 
2966
3273
  ### HTTP request headers
2967
3274
 
@@ -2970,21 +3277,594 @@ Name | Type | Description | Notes
2970
3277
 
2971
3278
 
2972
3279
 
2973
- <a name="patch_workforcemanagement_timeoffrequest"></a>
3280
+ <a name="patch_workforcemanagement_managementunit_settings"></a>
2974
3281
 
2975
- ## [**TimeOffRequestResponse**](TimeOffRequestResponse.html) patch_workforcemanagement_timeoffrequest(time_off_request_id, opts)
3282
+ ## [**ManagementUnitSettings**](ManagementUnitSettings.html) patch_workforcemanagement_managementunit_settings(mu_id, opts)
2976
3283
 
2977
3284
 
2978
3285
 
2979
- Update a time off request for the current user
3286
+ Patch the settings for the requested management unit
2980
3287
 
2981
3288
 
2982
3289
 
2983
- Wraps PATCH /api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}
3290
+ Wraps PATCH /api/v2/workforcemanagement/managementunits/{muId}/settings
2984
3291
 
2985
3292
  Requires ANY permissions:
2986
3293
 
2987
- * wfm:agentTimeOffRequest:submit
3294
+ * wfm:managementUnit:administer
3295
+ * wfm:managementUnit:edit
3296
+
3297
+
3298
+ ### Example
3299
+ ```{"language":"ruby"}
3300
+ # load the gem
3301
+ require 'purecloudplatformclientv2'
3302
+ # setup authorization
3303
+ @secret = ENV['PURECLOUD_SECRET']
3304
+ @id = ENV['PURECLOUD_CLIENT_ID']
3305
+ environment = "mypurecloud.com"
3306
+
3307
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
3308
+
3309
+ PureCloud.configure do |config|
3310
+ config.access_token = @authToken
3311
+ end
3312
+
3313
+ api_instance = PureCloud::WorkforceManagementApi.new
3314
+
3315
+ mu_id = "mu_id_example" # String | The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
3316
+
3317
+ opts = {
3318
+ body: PureCloud::ManagementUnitSettings.new # ManagementUnitSettings | config
3319
+ }
3320
+
3321
+ begin
3322
+ #Patch the settings for the requested management unit
3323
+ result = api_instance.patch_workforcemanagement_managementunit_settings(mu_id, opts)
3324
+ p result
3325
+ rescue PureCloud::ApiError => e
3326
+ puts "Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit_settings: #{e}"
3327
+ end
3328
+ ```
3329
+
3330
+ ### Parameters
3331
+
3332
+ Name | Type | Description | Notes
3333
+ ------------- | ------------- | ------------- | -------------
3334
+ **mu_id** | **String**| The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
3335
+ **body** | [**ManagementUnitSettings**](ManagementUnitSettings.html)| config | [optional] |
3336
+ {: class="table table-striped"}
3337
+
3338
+
3339
+ ### Return type
3340
+
3341
+ [**ManagementUnitSettings**](ManagementUnitSettings.html)
3342
+
3343
+ ### HTTP request headers
3344
+
3345
+ - **Content-Type**: application/json
3346
+ - **Accept**: application/json
3347
+
3348
+
3349
+
3350
+ <a name="patch_workforcemanagement_managementunit_user_timeoffrequest"></a>
3351
+
3352
+ ## [**TimeOffRequestResponse**](TimeOffRequestResponse.html) patch_workforcemanagement_managementunit_user_timeoffrequest(mu_id, user_id, time_off_request_id, opts)
3353
+
3354
+
3355
+
3356
+ Update a time off request
3357
+
3358
+
3359
+
3360
+ Wraps PATCH /api/v2/workforcemanagement/managementunits/{muId}/users/{userId}/timeoffrequests/{timeOffRequestId}
3361
+
3362
+ Requires ANY permissions:
3363
+
3364
+ * wfm:timeOffRequest:administer
3365
+ * wfm:timeOffRequest:edit
3366
+
3367
+
3368
+ ### Example
3369
+ ```{"language":"ruby"}
3370
+ # load the gem
3371
+ require 'purecloudplatformclientv2'
3372
+ # setup authorization
3373
+ @secret = ENV['PURECLOUD_SECRET']
3374
+ @id = ENV['PURECLOUD_CLIENT_ID']
3375
+ environment = "mypurecloud.com"
3376
+
3377
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
3378
+
3379
+ PureCloud.configure do |config|
3380
+ config.access_token = @authToken
3381
+ end
3382
+
3383
+ api_instance = PureCloud::WorkforceManagementApi.new
3384
+
3385
+ mu_id = "mu_id_example" # String | The muId of the management unit, or 'mine' for the management unit of the logged-in user.
3386
+
3387
+ user_id = "user_id_example" # String | The id of the user the requested time off request belongs to
3388
+
3389
+ time_off_request_id = "time_off_request_id_example" # String | The id of the time off request to update
3390
+
3391
+ opts = {
3392
+ body: PureCloud::AdminTimeOffRequestPatch.new # AdminTimeOffRequestPatch | body
3393
+ }
3394
+
3395
+ begin
3396
+ #Update a time off request
3397
+ result = api_instance.patch_workforcemanagement_managementunit_user_timeoffrequest(mu_id, user_id, time_off_request_id, opts)
3398
+ p result
3399
+ rescue PureCloud::ApiError => e
3400
+ puts "Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit_user_timeoffrequest: #{e}"
3401
+ end
3402
+ ```
3403
+
3404
+ ### Parameters
3405
+
3406
+ Name | Type | Description | Notes
3407
+ ------------- | ------------- | ------------- | -------------
3408
+ **mu_id** | **String**| The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
3409
+ **user_id** | **String**| The id of the user the requested time off request belongs to | |
3410
+ **time_off_request_id** | **String**| The id of the time off request to update | |
3411
+ **body** | [**AdminTimeOffRequestPatch**](AdminTimeOffRequestPatch.html)| body | [optional] |
3412
+ {: class="table table-striped"}
3413
+
3414
+
3415
+ ### Return type
3416
+
3417
+ [**TimeOffRequestResponse**](TimeOffRequestResponse.html)
3418
+
3419
+ ### HTTP request headers
3420
+
3421
+ - **Content-Type**: application/json
3422
+ - **Accept**: application/json
3423
+
3424
+
3425
+
3426
+ <a name="patch_workforcemanagement_managementunit_week_schedule"></a>
3427
+
3428
+ ## [**AsyncWeekScheduleResponse**](AsyncWeekScheduleResponse.html) patch_workforcemanagement_managementunit_week_schedule(management_unit_id, week_id, schedule_id, opts)
3429
+
3430
+
3431
+
3432
+ Update a week schedule
3433
+
3434
+
3435
+
3436
+ Wraps PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}
3437
+
3438
+ Requires ANY permissions:
3439
+
3440
+ * wfm:schedule:administer
3441
+ * wfm:schedule:edit
3442
+
3443
+
3444
+ ### Example
3445
+ ```{"language":"ruby"}
3446
+ # load the gem
3447
+ require 'purecloudplatformclientv2'
3448
+ # setup authorization
3449
+ @secret = ENV['PURECLOUD_SECRET']
3450
+ @id = ENV['PURECLOUD_CLIENT_ID']
3451
+ environment = "mypurecloud.com"
3452
+
3453
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
3454
+
3455
+ PureCloud.configure do |config|
3456
+ config.access_token = @authToken
3457
+ end
3458
+
3459
+ api_instance = PureCloud::WorkforceManagementApi.new
3460
+
3461
+ 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.
3462
+
3463
+ week_id = "week_id_example" # String | First day of schedule week in yyyy-MM-dd format.
3464
+
3465
+ schedule_id = "schedule_id_example" # String | The ID of the schedule to update. Use partial uploads of user schedules if activity count in schedule is greater than 17500
3466
+
3467
+ opts = {
3468
+ force_async: true, # BOOLEAN | Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
3469
+ force_download_service: true, # BOOLEAN | Force the result of this operation to be sent via download service. For testing/app development purposes
3470
+ body: PureCloud::UpdateWeekScheduleRequest.new # UpdateWeekScheduleRequest | body
3471
+ }
3472
+
3473
+ begin
3474
+ #Update a week schedule
3475
+ result = api_instance.patch_workforcemanagement_managementunit_week_schedule(management_unit_id, week_id, schedule_id, opts)
3476
+ p result
3477
+ rescue PureCloud::ApiError => e
3478
+ puts "Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit_week_schedule: #{e}"
3479
+ end
3480
+ ```
3481
+
3482
+ ### Parameters
3483
+
3484
+ Name | Type | Description | Notes
3485
+ ------------- | ------------- | ------------- | -------------
3486
+ **management_unit_id** | **String**| The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
3487
+ **week_id** | **String**| First day of schedule week in yyyy-MM-dd format. | |
3488
+ **schedule_id** | **String**| The ID of the schedule to update. Use partial uploads of user schedules if activity count in schedule is greater than 17500 | |
3489
+ **force_async** | **BOOLEAN**| Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes | [optional] |
3490
+ **force_download_service** | **BOOLEAN**| Force the result of this operation to be sent via download service. For testing/app development purposes | [optional] |
3491
+ **body** | [**UpdateWeekScheduleRequest**](UpdateWeekScheduleRequest.html)| body | [optional] |
3492
+ {: class="table table-striped"}
3493
+
3494
+
3495
+ ### Return type
3496
+
3497
+ [**AsyncWeekScheduleResponse**](AsyncWeekScheduleResponse.html)
3498
+
3499
+ ### HTTP request headers
3500
+
3501
+ - **Content-Type**: application/json
3502
+ - **Accept**: application/json
3503
+
3504
+
3505
+
3506
+ <a name="patch_workforcemanagement_managementunit_workplan"></a>
3507
+
3508
+ ## [**WorkPlan**](WorkPlan.html) patch_workforcemanagement_managementunit_workplan(management_unit_id, work_plan_id, opts)
3509
+
3510
+
3511
+
3512
+ Update a work plan
3513
+
3514
+
3515
+
3516
+ Wraps PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}
3517
+
3518
+ Requires ANY permissions:
3519
+
3520
+ * wfm:workPlan:administer
3521
+ * wfm:workPlan:edit
3522
+
3523
+
3524
+ ### Example
3525
+ ```{"language":"ruby"}
3526
+ # load the gem
3527
+ require 'purecloudplatformclientv2'
3528
+ # setup authorization
3529
+ @secret = ENV['PURECLOUD_SECRET']
3530
+ @id = ENV['PURECLOUD_CLIENT_ID']
3531
+ environment = "mypurecloud.com"
3532
+
3533
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
3534
+
3535
+ PureCloud.configure do |config|
3536
+ config.access_token = @authToken
3537
+ end
3538
+
3539
+ api_instance = PureCloud::WorkforceManagementApi.new
3540
+
3541
+ 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.
3542
+
3543
+ work_plan_id = "work_plan_id_example" # String | The ID of the work plan to update
3544
+
3545
+ opts = {
3546
+ body: PureCloud::WorkPlan.new # WorkPlan | body
3547
+ }
3548
+
3549
+ begin
3550
+ #Update a work plan
3551
+ result = api_instance.patch_workforcemanagement_managementunit_workplan(management_unit_id, work_plan_id, opts)
3552
+ p result
3553
+ rescue PureCloud::ApiError => e
3554
+ puts "Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit_workplan: #{e}"
3555
+ end
3556
+ ```
3557
+
3558
+ ### Parameters
3559
+
3560
+ Name | Type | Description | Notes
3561
+ ------------- | ------------- | ------------- | -------------
3562
+ **management_unit_id** | **String**| The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
3563
+ **work_plan_id** | **String**| The ID of the work plan to update | |
3564
+ **body** | [**WorkPlan**](WorkPlan.html)| body | [optional] |
3565
+ {: class="table table-striped"}
3566
+
3567
+
3568
+ ### Return type
3569
+
3570
+ [**WorkPlan**](WorkPlan.html)
3571
+
3572
+ ### HTTP request headers
3573
+
3574
+ - **Content-Type**: application/json
3575
+ - **Accept**: application/json
3576
+
3577
+
3578
+
3579
+ <a name="patch_workforcemanagement_timeoffrequest"></a>
3580
+
3581
+ ## [**TimeOffRequestResponse**](TimeOffRequestResponse.html) patch_workforcemanagement_timeoffrequest(time_off_request_id, opts)
3582
+
3583
+
3584
+
3585
+ Update a time off request for the current user
3586
+
3587
+
3588
+
3589
+ Wraps PATCH /api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}
3590
+
3591
+ Requires ANY permissions:
3592
+
3593
+ * wfm:agentTimeOffRequest:submit
3594
+
3595
+
3596
+ ### Example
3597
+ ```{"language":"ruby"}
3598
+ # load the gem
3599
+ require 'purecloudplatformclientv2'
3600
+ # setup authorization
3601
+ @secret = ENV['PURECLOUD_SECRET']
3602
+ @id = ENV['PURECLOUD_CLIENT_ID']
3603
+ environment = "mypurecloud.com"
3604
+
3605
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
3606
+
3607
+ PureCloud.configure do |config|
3608
+ config.access_token = @authToken
3609
+ end
3610
+
3611
+ api_instance = PureCloud::WorkforceManagementApi.new
3612
+
3613
+ time_off_request_id = "time_off_request_id_example" # String | Time Off Request Id
3614
+
3615
+ opts = {
3616
+ body: PureCloud::AgentTimeOffRequestPatch.new # AgentTimeOffRequestPatch | body
3617
+ }
3618
+
3619
+ begin
3620
+ #Update a time off request for the current user
3621
+ result = api_instance.patch_workforcemanagement_timeoffrequest(time_off_request_id, opts)
3622
+ p result
3623
+ rescue PureCloud::ApiError => e
3624
+ puts "Exception when calling WorkforceManagementApi->patch_workforcemanagement_timeoffrequest: #{e}"
3625
+ end
3626
+ ```
3627
+
3628
+ ### Parameters
3629
+
3630
+ Name | Type | Description | Notes
3631
+ ------------- | ------------- | ------------- | -------------
3632
+ **time_off_request_id** | **String**| Time Off Request Id | |
3633
+ **body** | [**AgentTimeOffRequestPatch**](AgentTimeOffRequestPatch.html)| body | [optional] |
3634
+ {: class="table table-striped"}
3635
+
3636
+
3637
+ ### Return type
3638
+
3639
+ [**TimeOffRequestResponse**](TimeOffRequestResponse.html)
3640
+
3641
+ ### HTTP request headers
3642
+
3643
+ - **Content-Type**: application/json
3644
+ - **Accept**: application/json
3645
+
3646
+
3647
+
3648
+ <a name="post_workforcemanagement_adherence_historical"></a>
3649
+
3650
+ ## [**WfmHistoricalAdherenceResponse**](WfmHistoricalAdherenceResponse.html) post_workforcemanagement_adherence_historical(opts)
3651
+
3652
+
3653
+
3654
+ Request a historical adherence report for users across management units
3655
+
3656
+
3657
+
3658
+ Wraps POST /api/v2/workforcemanagement/adherence/historical
3659
+
3660
+ Requires ANY permissions:
3661
+
3662
+ * wfm:historicalAdherence:view
3663
+
3664
+
3665
+ ### Example
3666
+ ```{"language":"ruby"}
3667
+ # load the gem
3668
+ require 'purecloudplatformclientv2'
3669
+ # setup authorization
3670
+ @secret = ENV['PURECLOUD_SECRET']
3671
+ @id = ENV['PURECLOUD_CLIENT_ID']
3672
+ environment = "mypurecloud.com"
3673
+
3674
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
3675
+
3676
+ PureCloud.configure do |config|
3677
+ config.access_token = @authToken
3678
+ end
3679
+
3680
+ api_instance = PureCloud::WorkforceManagementApi.new
3681
+
3682
+ opts = {
3683
+ body: PureCloud::WfmHistoricalAdherenceQueryForUsers.new # WfmHistoricalAdherenceQueryForUsers | body
3684
+ }
3685
+
3686
+ begin
3687
+ #Request a historical adherence report for users across management units
3688
+ result = api_instance.post_workforcemanagement_adherence_historical(opts)
3689
+ p result
3690
+ rescue PureCloud::ApiError => e
3691
+ puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_adherence_historical: #{e}"
3692
+ end
3693
+ ```
3694
+
3695
+ ### Parameters
3696
+
3697
+ Name | Type | Description | Notes
3698
+ ------------- | ------------- | ------------- | -------------
3699
+ **body** | [**WfmHistoricalAdherenceQueryForUsers**](WfmHistoricalAdherenceQueryForUsers.html)| body | [optional] |
3700
+ {: class="table table-striped"}
3701
+
3702
+
3703
+ ### Return type
3704
+
3705
+ [**WfmHistoricalAdherenceResponse**](WfmHistoricalAdherenceResponse.html)
3706
+
3707
+ ### HTTP request headers
3708
+
3709
+ - **Content-Type**: application/json
3710
+ - **Accept**: application/json
3711
+
3712
+
3713
+
3714
+ <a name="post_workforcemanagement_managementunit_activitycodes"></a>
3715
+
3716
+ ## [**ActivityCode**](ActivityCode.html) post_workforcemanagement_managementunit_activitycodes(mu_id, opts)
3717
+
3718
+
3719
+
3720
+ Create a new activity code
3721
+
3722
+
3723
+
3724
+ Wraps POST /api/v2/workforcemanagement/managementunits/{muId}/activitycodes
3725
+
3726
+ Requires ANY permissions:
3727
+
3728
+ * wfm:activityCode:add
3729
+ * wfm:activityCode:administer
3730
+
3731
+
3732
+ ### Example
3733
+ ```{"language":"ruby"}
3734
+ # load the gem
3735
+ require 'purecloudplatformclientv2'
3736
+ # setup authorization
3737
+ @secret = ENV['PURECLOUD_SECRET']
3738
+ @id = ENV['PURECLOUD_CLIENT_ID']
3739
+ environment = "mypurecloud.com"
3740
+
3741
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
3742
+
3743
+ PureCloud.configure do |config|
3744
+ config.access_token = @authToken
3745
+ end
3746
+
3747
+ api_instance = PureCloud::WorkforceManagementApi.new
3748
+
3749
+ mu_id = "mu_id_example" # String | The ID of the management unit, or 'mine' for the management unit of the logged-in user.
3750
+
3751
+ opts = {
3752
+ body: PureCloud::CreateActivityCodeRequest.new # CreateActivityCodeRequest | body
3753
+ }
3754
+
3755
+ begin
3756
+ #Create a new activity code
3757
+ result = api_instance.post_workforcemanagement_managementunit_activitycodes(mu_id, opts)
3758
+ p result
3759
+ rescue PureCloud::ApiError => e
3760
+ puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_activitycodes: #{e}"
3761
+ end
3762
+ ```
3763
+
3764
+ ### Parameters
3765
+
3766
+ Name | Type | Description | Notes
3767
+ ------------- | ------------- | ------------- | -------------
3768
+ **mu_id** | **String**| The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
3769
+ **body** | [**CreateActivityCodeRequest**](CreateActivityCodeRequest.html)| body | [optional] |
3770
+ {: class="table table-striped"}
3771
+
3772
+
3773
+ ### Return type
3774
+
3775
+ [**ActivityCode**](ActivityCode.html)
3776
+
3777
+ ### HTTP request headers
3778
+
3779
+ - **Content-Type**: application/json
3780
+ - **Accept**: application/json
3781
+
3782
+
3783
+
3784
+ <a name="post_workforcemanagement_managementunit_historicaladherencequery"></a>
3785
+
3786
+ ## [**WfmHistoricalAdherenceResponse**](WfmHistoricalAdherenceResponse.html) post_workforcemanagement_managementunit_historicaladherencequery(mu_id, opts)
3787
+
3788
+
3789
+
3790
+ Request a historical adherence report
3791
+
3792
+ The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true
3793
+
3794
+ Wraps POST /api/v2/workforcemanagement/managementunits/{muId}/historicaladherencequery
3795
+
3796
+ Requires ANY permissions:
3797
+
3798
+ * wfm:historicalAdherence:view
3799
+
3800
+
3801
+ ### Example
3802
+ ```{"language":"ruby"}
3803
+ # load the gem
3804
+ require 'purecloudplatformclientv2'
3805
+ # setup authorization
3806
+ @secret = ENV['PURECLOUD_SECRET']
3807
+ @id = ENV['PURECLOUD_CLIENT_ID']
3808
+ environment = "mypurecloud.com"
3809
+
3810
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
3811
+
3812
+ PureCloud.configure do |config|
3813
+ config.access_token = @authToken
3814
+ end
3815
+
3816
+ api_instance = PureCloud::WorkforceManagementApi.new
3817
+
3818
+ mu_id = "mu_id_example" # String | The management unit ID of the management unit
3819
+
3820
+ opts = {
3821
+ body: PureCloud::WfmHistoricalAdherenceQuery.new # WfmHistoricalAdherenceQuery | body
3822
+ }
3823
+
3824
+ begin
3825
+ #Request a historical adherence report
3826
+ result = api_instance.post_workforcemanagement_managementunit_historicaladherencequery(mu_id, opts)
3827
+ p result
3828
+ rescue PureCloud::ApiError => e
3829
+ puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_historicaladherencequery: #{e}"
3830
+ end
3831
+ ```
3832
+
3833
+ ### Parameters
3834
+
3835
+ Name | Type | Description | Notes
3836
+ ------------- | ------------- | ------------- | -------------
3837
+ **mu_id** | **String**| The management unit ID of the management unit | |
3838
+ **body** | [**WfmHistoricalAdherenceQuery**](WfmHistoricalAdherenceQuery.html)| body | [optional] |
3839
+ {: class="table table-striped"}
3840
+
3841
+
3842
+ ### Return type
3843
+
3844
+ [**WfmHistoricalAdherenceResponse**](WfmHistoricalAdherenceResponse.html)
3845
+
3846
+ ### HTTP request headers
3847
+
3848
+ - **Content-Type**: application/json
3849
+ - **Accept**: application/json
3850
+
3851
+
3852
+
3853
+ <a name="post_workforcemanagement_managementunit_intraday"></a>
3854
+
3855
+ ## [**IntradayResponse**](IntradayResponse.html) post_workforcemanagement_managementunit_intraday(mu_id, opts)
3856
+
3857
+
3858
+
3859
+ Get intraday data for the given date for the requested queueIds
3860
+
3861
+
3862
+
3863
+ Wraps POST /api/v2/workforcemanagement/managementunits/{muId}/intraday
3864
+
3865
+ Requires ANY permissions:
3866
+
3867
+ * wfm:intraday:view
2988
3868
 
2989
3869
 
2990
3870
  ### Example
@@ -3004,18 +3884,18 @@ end
3004
3884
 
3005
3885
  api_instance = PureCloud::WorkforceManagementApi.new
3006
3886
 
3007
- time_off_request_id = "time_off_request_id_example" # String | Time Off Request Id
3887
+ mu_id = "mu_id_example" # String | The management unit ID of the management unit
3008
3888
 
3009
3889
  opts = {
3010
- body: PureCloud::AgentTimeOffRequestPatch.new # AgentTimeOffRequestPatch | body
3890
+ body: PureCloud::IntradayQueryDataCommand.new # IntradayQueryDataCommand | body
3011
3891
  }
3012
3892
 
3013
3893
  begin
3014
- #Update a time off request for the current user
3015
- result = api_instance.patch_workforcemanagement_timeoffrequest(time_off_request_id, opts)
3894
+ #Get intraday data for the given date for the requested queueIds
3895
+ result = api_instance.post_workforcemanagement_managementunit_intraday(mu_id, opts)
3016
3896
  p result
3017
3897
  rescue PureCloud::ApiError => e
3018
- puts "Exception when calling WorkforceManagementApi->patch_workforcemanagement_timeoffrequest: #{e}"
3898
+ puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_intraday: #{e}"
3019
3899
  end
3020
3900
  ```
3021
3901
 
@@ -3023,14 +3903,14 @@ end
3023
3903
 
3024
3904
  Name | Type | Description | Notes
3025
3905
  ------------- | ------------- | ------------- | -------------
3026
- **time_off_request_id** | **String**| Time Off Request Id | |
3027
- **body** | [**AgentTimeOffRequestPatch**](AgentTimeOffRequestPatch.html)| body | [optional] |
3906
+ **mu_id** | **String**| The management unit ID of the management unit | |
3907
+ **body** | [**IntradayQueryDataCommand**](IntradayQueryDataCommand.html)| body | [optional] |
3028
3908
  {: class="table table-striped"}
3029
3909
 
3030
3910
 
3031
3911
  ### Return type
3032
3912
 
3033
- [**TimeOffRequestResponse**](TimeOffRequestResponse.html)
3913
+ [**IntradayResponse**](IntradayResponse.html)
3034
3914
 
3035
3915
  ### HTTP request headers
3036
3916
 
@@ -3039,21 +3919,23 @@ Name | Type | Description | Notes
3039
3919
 
3040
3920
 
3041
3921
 
3042
- <a name="post_workforcemanagement_adherence_historical"></a>
3922
+ <a name="post_workforcemanagement_managementunit_schedules_search"></a>
3043
3923
 
3044
- ## [**WfmHistoricalAdherenceResponse**](WfmHistoricalAdherenceResponse.html) post_workforcemanagement_adherence_historical(opts)
3924
+ ## [**UserScheduleContainer**](UserScheduleContainer.html) post_workforcemanagement_managementunit_schedules_search(mu_id, opts)
3045
3925
 
3046
3926
 
3047
3927
 
3048
- Request a historical adherence report for users across management units
3928
+ Query published schedules for given given time range for set of users
3049
3929
 
3050
3930
 
3051
3931
 
3052
- Wraps POST /api/v2/workforcemanagement/adherence/historical
3932
+ Wraps POST /api/v2/workforcemanagement/managementunits/{muId}/schedules/search
3053
3933
 
3054
3934
  Requires ANY permissions:
3055
3935
 
3056
- * wfm:historicalAdherence:view
3936
+ * wfm:publishedSchedule:view
3937
+ * wfm:schedule:administer
3938
+ * wfm:schedule:view
3057
3939
 
3058
3940
 
3059
3941
  ### Example
@@ -3073,16 +3955,18 @@ end
3073
3955
 
3074
3956
  api_instance = PureCloud::WorkforceManagementApi.new
3075
3957
 
3958
+ mu_id = "mu_id_example" # String | The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
3959
+
3076
3960
  opts = {
3077
- body: PureCloud::WfmHistoricalAdherenceQueryForUsers.new # WfmHistoricalAdherenceQueryForUsers | body
3961
+ body: PureCloud::UserListScheduleRequestBody.new # UserListScheduleRequestBody | body
3078
3962
  }
3079
3963
 
3080
3964
  begin
3081
- #Request a historical adherence report for users across management units
3082
- result = api_instance.post_workforcemanagement_adherence_historical(opts)
3965
+ #Query published schedules for given given time range for set of users
3966
+ result = api_instance.post_workforcemanagement_managementunit_schedules_search(mu_id, opts)
3083
3967
  p result
3084
3968
  rescue PureCloud::ApiError => e
3085
- puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_adherence_historical: #{e}"
3969
+ puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_schedules_search: #{e}"
3086
3970
  end
3087
3971
  ```
3088
3972
 
@@ -3090,13 +3974,14 @@ end
3090
3974
 
3091
3975
  Name | Type | Description | Notes
3092
3976
  ------------- | ------------- | ------------- | -------------
3093
- **body** | [**WfmHistoricalAdherenceQueryForUsers**](WfmHistoricalAdherenceQueryForUsers.html)| body | [optional] |
3977
+ **mu_id** | **String**| The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
3978
+ **body** | [**UserListScheduleRequestBody**](UserListScheduleRequestBody.html)| body | [optional] |
3094
3979
  {: class="table table-striped"}
3095
3980
 
3096
3981
 
3097
3982
  ### Return type
3098
3983
 
3099
- [**WfmHistoricalAdherenceResponse**](WfmHistoricalAdherenceResponse.html)
3984
+ [**UserScheduleContainer**](UserScheduleContainer.html)
3100
3985
 
3101
3986
  ### HTTP request headers
3102
3987
 
@@ -3105,22 +3990,22 @@ Name | Type | Description | Notes
3105
3990
 
3106
3991
 
3107
3992
 
3108
- <a name="post_workforcemanagement_managementunit_activitycodes"></a>
3993
+ <a name="post_workforcemanagement_managementunit_servicegoalgroups"></a>
3109
3994
 
3110
- ## [**ActivityCode**](ActivityCode.html) post_workforcemanagement_managementunit_activitycodes(mu_id, opts)
3995
+ ## [**ServiceGoalGroup**](ServiceGoalGroup.html) post_workforcemanagement_managementunit_servicegoalgroups(management_unit_id, opts)
3111
3996
 
3112
3997
 
3113
3998
 
3114
- Create a new activity code
3999
+ Create a new service goal group
3115
4000
 
3116
4001
 
3117
4002
 
3118
- Wraps POST /api/v2/workforcemanagement/managementunits/{muId}/activitycodes
4003
+ Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups
3119
4004
 
3120
4005
  Requires ANY permissions:
3121
4006
 
3122
- * wfm:activityCode:add
3123
- * wfm:activityCode:administer
4007
+ * wfm:serviceGoalGroup:add
4008
+ * wfm:serviceGoalGroup:administer
3124
4009
 
3125
4010
 
3126
4011
  ### Example
@@ -3140,18 +4025,18 @@ end
3140
4025
 
3141
4026
  api_instance = PureCloud::WorkforceManagementApi.new
3142
4027
 
3143
- mu_id = "mu_id_example" # String | The ID of the management unit, or 'mine' for the management unit of the logged-in user.
4028
+ 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.
3144
4029
 
3145
4030
  opts = {
3146
- body: PureCloud::CreateActivityCodeRequest.new # CreateActivityCodeRequest | body
4031
+ body: PureCloud::CreateServiceGoalGroupRequest.new # CreateServiceGoalGroupRequest | body
3147
4032
  }
3148
4033
 
3149
4034
  begin
3150
- #Create a new activity code
3151
- result = api_instance.post_workforcemanagement_managementunit_activitycodes(mu_id, opts)
4035
+ #Create a new service goal group
4036
+ result = api_instance.post_workforcemanagement_managementunit_servicegoalgroups(management_unit_id, opts)
3152
4037
  p result
3153
4038
  rescue PureCloud::ApiError => e
3154
- puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_activitycodes: #{e}"
4039
+ puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_servicegoalgroups: #{e}"
3155
4040
  end
3156
4041
  ```
3157
4042
 
@@ -3159,14 +4044,14 @@ end
3159
4044
 
3160
4045
  Name | Type | Description | Notes
3161
4046
  ------------- | ------------- | ------------- | -------------
3162
- **mu_id** | **String**| The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
3163
- **body** | [**CreateActivityCodeRequest**](CreateActivityCodeRequest.html)| body | [optional] |
4047
+ **management_unit_id** | **String**| The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
4048
+ **body** | [**CreateServiceGoalGroupRequest**](CreateServiceGoalGroupRequest.html)| body | [optional] |
3164
4049
  {: class="table table-striped"}
3165
4050
 
3166
4051
 
3167
4052
  ### Return type
3168
4053
 
3169
- [**ActivityCode**](ActivityCode.html)
4054
+ [**ServiceGoalGroup**](ServiceGoalGroup.html)
3170
4055
 
3171
4056
  ### HTTP request headers
3172
4057
 
@@ -3175,21 +4060,22 @@ Name | Type | Description | Notes
3175
4060
 
3176
4061
 
3177
4062
 
3178
- <a name="post_workforcemanagement_managementunit_historicaladherencequery"></a>
4063
+ <a name="post_workforcemanagement_managementunit_timeoffrequests"></a>
3179
4064
 
3180
- ## [**WfmHistoricalAdherenceResponse**](WfmHistoricalAdherenceResponse.html) post_workforcemanagement_managementunit_historicaladherencequery(mu_id, opts)
4065
+ ## [**TimeOffRequestList**](TimeOffRequestList.html) post_workforcemanagement_managementunit_timeoffrequests(mu_id, opts)
3181
4066
 
3182
4067
 
3183
4068
 
3184
- Request a historical adherence report
4069
+ Create a new time off request
3185
4070
 
3186
- The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true
3187
4071
 
3188
- Wraps POST /api/v2/workforcemanagement/managementunits/{muId}/historicaladherencequery
4072
+
4073
+ Wraps POST /api/v2/workforcemanagement/managementunits/{muId}/timeoffrequests
3189
4074
 
3190
4075
  Requires ANY permissions:
3191
4076
 
3192
- * wfm:historicalAdherence:view
4077
+ * wfm:timeOffRequest:administer
4078
+ * wfm:timeOffRequest:add
3193
4079
 
3194
4080
 
3195
4081
  ### Example
@@ -3209,18 +4095,18 @@ end
3209
4095
 
3210
4096
  api_instance = PureCloud::WorkforceManagementApi.new
3211
4097
 
3212
- mu_id = "mu_id_example" # String | The management unit ID of the management unit
4098
+ mu_id = "mu_id_example" # String | The muId of the management unit, or 'mine' for the management unit of the logged-in user.
3213
4099
 
3214
4100
  opts = {
3215
- body: PureCloud::WfmHistoricalAdherenceQuery.new # WfmHistoricalAdherenceQuery | body
4101
+ body: PureCloud::CreateAdminTimeOffRequest.new # CreateAdminTimeOffRequest | body
3216
4102
  }
3217
4103
 
3218
4104
  begin
3219
- #Request a historical adherence report
3220
- result = api_instance.post_workforcemanagement_managementunit_historicaladherencequery(mu_id, opts)
4105
+ #Create a new time off request
4106
+ result = api_instance.post_workforcemanagement_managementunit_timeoffrequests(mu_id, opts)
3221
4107
  p result
3222
4108
  rescue PureCloud::ApiError => e
3223
- puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_historicaladherencequery: #{e}"
4109
+ puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_timeoffrequests: #{e}"
3224
4110
  end
3225
4111
  ```
3226
4112
 
@@ -3228,14 +4114,14 @@ end
3228
4114
 
3229
4115
  Name | Type | Description | Notes
3230
4116
  ------------- | ------------- | ------------- | -------------
3231
- **mu_id** | **String**| The management unit ID of the management unit | |
3232
- **body** | [**WfmHistoricalAdherenceQuery**](WfmHistoricalAdherenceQuery.html)| body | [optional] |
4117
+ **mu_id** | **String**| The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
4118
+ **body** | [**CreateAdminTimeOffRequest**](CreateAdminTimeOffRequest.html)| body | [optional] |
3233
4119
  {: class="table table-striped"}
3234
4120
 
3235
4121
 
3236
4122
  ### Return type
3237
4123
 
3238
- [**WfmHistoricalAdherenceResponse**](WfmHistoricalAdherenceResponse.html)
4124
+ [**TimeOffRequestList**](TimeOffRequestList.html)
3239
4125
 
3240
4126
  ### HTTP request headers
3241
4127
 
@@ -3244,21 +4130,22 @@ Name | Type | Description | Notes
3244
4130
 
3245
4131
 
3246
4132
 
3247
- <a name="post_workforcemanagement_managementunit_intraday"></a>
4133
+ <a name="post_workforcemanagement_managementunit_timeoffrequests_fetchdetails"></a>
3248
4134
 
3249
- ## [**IntradayResponse**](IntradayResponse.html) post_workforcemanagement_managementunit_intraday(mu_id, opts)
4135
+ ## [**TimeOffRequestEntityList**](TimeOffRequestEntityList.html) post_workforcemanagement_managementunit_timeoffrequests_fetchdetails(mu_id, opts)
3250
4136
 
3251
4137
 
3252
4138
 
3253
- Get intraday data for the given date for the requested queueIds
4139
+ Gets a list of time off requests from lookup ids
3254
4140
 
3255
4141
 
3256
4142
 
3257
- Wraps POST /api/v2/workforcemanagement/managementunits/{muId}/intraday
4143
+ Wraps POST /api/v2/workforcemanagement/managementunits/{muId}/timeoffrequests/fetchdetails
3258
4144
 
3259
4145
  Requires ANY permissions:
3260
4146
 
3261
- * wfm:intraday:view
4147
+ * wfm:timeOffRequest:administer
4148
+ * wfm:timeOffRequest:view
3262
4149
 
3263
4150
 
3264
4151
  ### Example
@@ -3278,18 +4165,18 @@ end
3278
4165
 
3279
4166
  api_instance = PureCloud::WorkforceManagementApi.new
3280
4167
 
3281
- mu_id = "mu_id_example" # String | The management unit ID of the management unit
4168
+ mu_id = "mu_id_example" # String | The muId of the management unit, or 'mine' for the management unit of the logged-in user.
3282
4169
 
3283
4170
  opts = {
3284
- body: PureCloud::IntradayQueryDataCommand.new # IntradayQueryDataCommand | body
4171
+ body: PureCloud::TimeOffRequestLookupList.new # TimeOffRequestLookupList | body
3285
4172
  }
3286
4173
 
3287
4174
  begin
3288
- #Get intraday data for the given date for the requested queueIds
3289
- result = api_instance.post_workforcemanagement_managementunit_intraday(mu_id, opts)
4175
+ #Gets a list of time off requests from lookup ids
4176
+ result = api_instance.post_workforcemanagement_managementunit_timeoffrequests_fetchdetails(mu_id, opts)
3290
4177
  p result
3291
4178
  rescue PureCloud::ApiError => e
3292
- puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_intraday: #{e}"
4179
+ puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_timeoffrequests_fetchdetails: #{e}"
3293
4180
  end
3294
4181
  ```
3295
4182
 
@@ -3297,14 +4184,14 @@ end
3297
4184
 
3298
4185
  Name | Type | Description | Notes
3299
4186
  ------------- | ------------- | ------------- | -------------
3300
- **mu_id** | **String**| The management unit ID of the management unit | |
3301
- **body** | [**IntradayQueryDataCommand**](IntradayQueryDataCommand.html)| body | [optional] |
4187
+ **mu_id** | **String**| The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
4188
+ **body** | [**TimeOffRequestLookupList**](TimeOffRequestLookupList.html)| body | [optional] |
3302
4189
  {: class="table table-striped"}
3303
4190
 
3304
4191
 
3305
4192
  ### Return type
3306
4193
 
3307
- [**IntradayResponse**](IntradayResponse.html)
4194
+ [**TimeOffRequestEntityList**](TimeOffRequestEntityList.html)
3308
4195
 
3309
4196
  ### HTTP request headers
3310
4197
 
@@ -3313,23 +4200,22 @@ Name | Type | Description | Notes
3313
4200
 
3314
4201
 
3315
4202
 
3316
- <a name="post_workforcemanagement_managementunit_schedules_search"></a>
4203
+ <a name="post_workforcemanagement_managementunit_timeoffrequests_query"></a>
3317
4204
 
3318
- ## [**UserScheduleContainer**](UserScheduleContainer.html) post_workforcemanagement_managementunit_schedules_search(mu_id, opts)
4205
+ ## [**TimeOffRequestLookupList**](TimeOffRequestLookupList.html) post_workforcemanagement_managementunit_timeoffrequests_query(mu_id, opts)
3319
4206
 
3320
4207
 
3321
4208
 
3322
- Query published schedules for given given time range for set of users
4209
+ Gets the lookup ids to fetch the specified set of requests
3323
4210
 
3324
4211
 
3325
4212
 
3326
- Wraps POST /api/v2/workforcemanagement/managementunits/{muId}/schedules/search
4213
+ Wraps POST /api/v2/workforcemanagement/managementunits/{muId}/timeoffrequests/query
3327
4214
 
3328
4215
  Requires ANY permissions:
3329
4216
 
3330
- * wfm:publishedSchedule:view
3331
- * wfm:schedule:administer
3332
- * wfm:schedule:view
4217
+ * wfm:timeOffRequest:administer
4218
+ * wfm:timeOffRequest:view
3333
4219
 
3334
4220
 
3335
4221
  ### Example
@@ -3349,18 +4235,18 @@ end
3349
4235
 
3350
4236
  api_instance = PureCloud::WorkforceManagementApi.new
3351
4237
 
3352
- mu_id = "mu_id_example" # String | The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
4238
+ mu_id = "mu_id_example" # String | The muId of the management unit, or 'mine' for the management unit of the logged-in user.
3353
4239
 
3354
4240
  opts = {
3355
- body: PureCloud::UserListScheduleRequestBody.new # UserListScheduleRequestBody | body
4241
+ body: PureCloud::TimeOffRequestQueryBody.new # TimeOffRequestQueryBody | body
3356
4242
  }
3357
4243
 
3358
4244
  begin
3359
- #Query published schedules for given given time range for set of users
3360
- result = api_instance.post_workforcemanagement_managementunit_schedules_search(mu_id, opts)
4245
+ #Gets the lookup ids to fetch the specified set of requests
4246
+ result = api_instance.post_workforcemanagement_managementunit_timeoffrequests_query(mu_id, opts)
3361
4247
  p result
3362
4248
  rescue PureCloud::ApiError => e
3363
- puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_schedules_search: #{e}"
4249
+ puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_timeoffrequests_query: #{e}"
3364
4250
  end
3365
4251
  ```
3366
4252
 
@@ -3368,14 +4254,14 @@ end
3368
4254
 
3369
4255
  Name | Type | Description | Notes
3370
4256
  ------------- | ------------- | ------------- | -------------
3371
- **mu_id** | **String**| The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
3372
- **body** | [**UserListScheduleRequestBody**](UserListScheduleRequestBody.html)| body | [optional] |
4257
+ **mu_id** | **String**| The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
4258
+ **body** | [**TimeOffRequestQueryBody**](TimeOffRequestQueryBody.html)| body | [optional] |
3373
4259
  {: class="table table-striped"}
3374
4260
 
3375
4261
 
3376
4262
  ### Return type
3377
4263
 
3378
- [**UserScheduleContainer**](UserScheduleContainer.html)
4264
+ [**TimeOffRequestLookupList**](TimeOffRequestLookupList.html)
3379
4265
 
3380
4266
  ### HTTP request headers
3381
4267
 
@@ -3384,22 +4270,22 @@ Name | Type | Description | Notes
3384
4270
 
3385
4271
 
3386
4272
 
3387
- <a name="post_workforcemanagement_managementunit_servicegoalgroups"></a>
4273
+ <a name="post_workforcemanagement_managementunit_week_schedule_copy"></a>
3388
4274
 
3389
- ## [**ServiceGoalGroup**](ServiceGoalGroup.html) post_workforcemanagement_managementunit_servicegoalgroups(management_unit_id, opts)
4275
+ ## [**AsyncWeekScheduleResponse**](AsyncWeekScheduleResponse.html) post_workforcemanagement_managementunit_week_schedule_copy(management_unit_id, week_id, schedule_id, opts)
3390
4276
 
3391
4277
 
3392
4278
 
3393
- Create a new service goal group
4279
+ Copy a week schedule
3394
4280
 
3395
4281
 
3396
4282
 
3397
- Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups
4283
+ Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}/copy
3398
4284
 
3399
4285
  Requires ANY permissions:
3400
4286
 
3401
- * wfm:serviceGoalGroup:add
3402
- * wfm:serviceGoalGroup:administer
4287
+ * wfm:schedule:add
4288
+ * wfm:schedule:administer
3403
4289
 
3404
4290
 
3405
4291
  ### Example
@@ -3421,16 +4307,22 @@ api_instance = PureCloud::WorkforceManagementApi.new
3421
4307
 
3422
4308
  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.
3423
4309
 
4310
+ week_id = "week_id_example" # String | First day of schedule week in yyyy-MM-dd format.
4311
+
4312
+ schedule_id = "schedule_id_example" # String | The ID of the schedule to copy from
4313
+
3424
4314
  opts = {
3425
- body: PureCloud::CreateServiceGoalGroupRequest.new # CreateServiceGoalGroupRequest | body
4315
+ force_async: true, # BOOLEAN | Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
4316
+ force_download_service: true, # BOOLEAN | Force the result of this operation to be sent via download service. For testing/app development purposes
4317
+ body: PureCloud::CopyWeekScheduleRequest.new # CopyWeekScheduleRequest | body
3426
4318
  }
3427
4319
 
3428
4320
  begin
3429
- #Create a new service goal group
3430
- result = api_instance.post_workforcemanagement_managementunit_servicegoalgroups(management_unit_id, opts)
4321
+ #Copy a week schedule
4322
+ result = api_instance.post_workforcemanagement_managementunit_week_schedule_copy(management_unit_id, week_id, schedule_id, opts)
3431
4323
  p result
3432
4324
  rescue PureCloud::ApiError => e
3433
- puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_servicegoalgroups: #{e}"
4325
+ puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_schedule_copy: #{e}"
3434
4326
  end
3435
4327
  ```
3436
4328
 
@@ -3439,13 +4331,17 @@ end
3439
4331
  Name | Type | Description | Notes
3440
4332
  ------------- | ------------- | ------------- | -------------
3441
4333
  **management_unit_id** | **String**| The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
3442
- **body** | [**CreateServiceGoalGroupRequest**](CreateServiceGoalGroupRequest.html)| body | [optional] |
4334
+ **week_id** | **String**| First day of schedule week in yyyy-MM-dd format. | |
4335
+ **schedule_id** | **String**| The ID of the schedule to copy from | |
4336
+ **force_async** | **BOOLEAN**| Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes | [optional] |
4337
+ **force_download_service** | **BOOLEAN**| Force the result of this operation to be sent via download service. For testing/app development purposes | [optional] |
4338
+ **body** | [**CopyWeekScheduleRequest**](CopyWeekScheduleRequest.html)| body | [optional] |
3443
4339
  {: class="table table-striped"}
3444
4340
 
3445
4341
 
3446
4342
  ### Return type
3447
4343
 
3448
- [**ServiceGoalGroup**](ServiceGoalGroup.html)
4344
+ [**AsyncWeekScheduleResponse**](AsyncWeekScheduleResponse.html)
3449
4345
 
3450
4346
  ### HTTP request headers
3451
4347
 
@@ -3454,22 +4350,22 @@ Name | Type | Description | Notes
3454
4350
 
3455
4351
 
3456
4352
 
3457
- <a name="post_workforcemanagement_managementunit_timeoffrequests"></a>
4353
+ <a name="post_workforcemanagement_managementunit_week_schedule_reschedule"></a>
3458
4354
 
3459
- ## [**TimeOffRequestList**](TimeOffRequestList.html) post_workforcemanagement_managementunit_timeoffrequests(mu_id, opts)
4355
+ ## [**AsyncWeekScheduleResponse**](AsyncWeekScheduleResponse.html) post_workforcemanagement_managementunit_week_schedule_reschedule(management_unit_id, week_id, schedule_id, opts)
3460
4356
 
3461
4357
 
3462
4358
 
3463
- Create a new time off request
4359
+ Start a scheduling run to compute the reschedule. When the scheduling run finishes, a client can get the reschedule changes and then the client can apply them to the schedule, save the schedule, and mark the scheduling run as applied
3464
4360
 
3465
4361
 
3466
4362
 
3467
- Wraps POST /api/v2/workforcemanagement/managementunits/{muId}/timeoffrequests
4363
+ Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}/reschedule
3468
4364
 
3469
4365
  Requires ANY permissions:
3470
4366
 
3471
- * wfm:timeOffRequest:administer
3472
- * wfm:timeOffRequest:add
4367
+ * wfm:schedule:administer
4368
+ * wfm:schedule:edit
3473
4369
 
3474
4370
 
3475
4371
  ### Example
@@ -3489,18 +4385,22 @@ end
3489
4385
 
3490
4386
  api_instance = PureCloud::WorkforceManagementApi.new
3491
4387
 
3492
- mu_id = "mu_id_example" # String | The muId of the management unit, or 'mine' for the management unit of the logged-in user.
4388
+ 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.
4389
+
4390
+ week_id = "week_id_example" # String | First day of schedule week in yyyy-MM-dd format.
4391
+
4392
+ schedule_id = "schedule_id_example" # String | The ID of the schedule to re-optimize
3493
4393
 
3494
4394
  opts = {
3495
- body: PureCloud::CreateAdminTimeOffRequest.new # CreateAdminTimeOffRequest | body
4395
+ body: PureCloud::RescheduleRequest.new # RescheduleRequest | body
3496
4396
  }
3497
4397
 
3498
4398
  begin
3499
- #Create a new time off request
3500
- result = api_instance.post_workforcemanagement_managementunit_timeoffrequests(mu_id, opts)
4399
+ #Start a scheduling run to compute the reschedule. When the scheduling run finishes, a client can get the reschedule changes and then the client can apply them to the schedule, save the schedule, and mark the scheduling run as applied
4400
+ result = api_instance.post_workforcemanagement_managementunit_week_schedule_reschedule(management_unit_id, week_id, schedule_id, opts)
3501
4401
  p result
3502
4402
  rescue PureCloud::ApiError => e
3503
- puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_timeoffrequests: #{e}"
4403
+ puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_schedule_reschedule: #{e}"
3504
4404
  end
3505
4405
  ```
3506
4406
 
@@ -3508,14 +4408,16 @@ end
3508
4408
 
3509
4409
  Name | Type | Description | Notes
3510
4410
  ------------- | ------------- | ------------- | -------------
3511
- **mu_id** | **String**| The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
3512
- **body** | [**CreateAdminTimeOffRequest**](CreateAdminTimeOffRequest.html)| body | [optional] |
4411
+ **management_unit_id** | **String**| The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
4412
+ **week_id** | **String**| First day of schedule week in yyyy-MM-dd format. | |
4413
+ **schedule_id** | **String**| The ID of the schedule to re-optimize | |
4414
+ **body** | [**RescheduleRequest**](RescheduleRequest.html)| body | [optional] |
3513
4415
  {: class="table table-striped"}
3514
4416
 
3515
4417
 
3516
4418
  ### Return type
3517
4419
 
3518
- [**TimeOffRequestList**](TimeOffRequestList.html)
4420
+ [**AsyncWeekScheduleResponse**](AsyncWeekScheduleResponse.html)
3519
4421
 
3520
4422
  ### HTTP request headers
3521
4423
 
@@ -3524,22 +4426,22 @@ Name | Type | Description | Notes
3524
4426
 
3525
4427
 
3526
4428
 
3527
- <a name="post_workforcemanagement_managementunit_timeoffrequests_fetchdetails"></a>
4429
+ <a name="post_workforcemanagement_managementunit_week_schedules"></a>
3528
4430
 
3529
- ## [**TimeOffRequestEntityList**](TimeOffRequestEntityList.html) post_workforcemanagement_managementunit_timeoffrequests_fetchdetails(mu_id, opts)
4431
+ ## [**AsyncWeekScheduleResponse**](AsyncWeekScheduleResponse.html) post_workforcemanagement_managementunit_week_schedules(management_unit_id, week_id, opts)
3530
4432
 
3531
4433
 
3532
4434
 
3533
- Gets a list of time off requests from lookup ids
4435
+ Add a schedule for a week in management unit using imported data. Use partial uploads of user schedules if activity count in schedule is greater than 17500
3534
4436
 
3535
4437
 
3536
4438
 
3537
- Wraps POST /api/v2/workforcemanagement/managementunits/{muId}/timeoffrequests/fetchdetails
4439
+ Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules
3538
4440
 
3539
4441
  Requires ANY permissions:
3540
4442
 
3541
- * wfm:timeOffRequest:administer
3542
- * wfm:timeOffRequest:view
4443
+ * wfm:schedule:add
4444
+ * wfm:schedule:administer
3543
4445
 
3544
4446
 
3545
4447
  ### Example
@@ -3559,18 +4461,22 @@ end
3559
4461
 
3560
4462
  api_instance = PureCloud::WorkforceManagementApi.new
3561
4463
 
3562
- mu_id = "mu_id_example" # String | The muId of the management unit, or 'mine' for the management unit of the logged-in user.
4464
+ 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.
4465
+
4466
+ week_id = "week_id_example" # String | First day of schedule week in yyyy-MM-dd format.
3563
4467
 
3564
4468
  opts = {
3565
- body: PureCloud::TimeOffRequestLookupList.new # TimeOffRequestLookupList | body
4469
+ force_async: true, # BOOLEAN | Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
4470
+ force_download_service: true, # BOOLEAN | Force the result of this operation to be sent via download service. For testing/app development purposes
4471
+ body: PureCloud::ImportWeekScheduleRequest.new # ImportWeekScheduleRequest | body
3566
4472
  }
3567
4473
 
3568
4474
  begin
3569
- #Gets a list of time off requests from lookup ids
3570
- result = api_instance.post_workforcemanagement_managementunit_timeoffrequests_fetchdetails(mu_id, opts)
4475
+ #Add a schedule for a week in management unit using imported data. Use partial uploads of user schedules if activity count in schedule is greater than 17500
4476
+ result = api_instance.post_workforcemanagement_managementunit_week_schedules(management_unit_id, week_id, opts)
3571
4477
  p result
3572
4478
  rescue PureCloud::ApiError => e
3573
- puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_timeoffrequests_fetchdetails: #{e}"
4479
+ puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_schedules: #{e}"
3574
4480
  end
3575
4481
  ```
3576
4482
 
@@ -3578,14 +4484,17 @@ end
3578
4484
 
3579
4485
  Name | Type | Description | Notes
3580
4486
  ------------- | ------------- | ------------- | -------------
3581
- **mu_id** | **String**| The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
3582
- **body** | [**TimeOffRequestLookupList**](TimeOffRequestLookupList.html)| body | [optional] |
4487
+ **management_unit_id** | **String**| The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
4488
+ **week_id** | **String**| First day of schedule week in yyyy-MM-dd format. | |
4489
+ **force_async** | **BOOLEAN**| Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes | [optional] |
4490
+ **force_download_service** | **BOOLEAN**| Force the result of this operation to be sent via download service. For testing/app development purposes | [optional] |
4491
+ **body** | [**ImportWeekScheduleRequest**](ImportWeekScheduleRequest.html)| body | [optional] |
3583
4492
  {: class="table table-striped"}
3584
4493
 
3585
4494
 
3586
4495
  ### Return type
3587
4496
 
3588
- [**TimeOffRequestEntityList**](TimeOffRequestEntityList.html)
4497
+ [**AsyncWeekScheduleResponse**](AsyncWeekScheduleResponse.html)
3589
4498
 
3590
4499
  ### HTTP request headers
3591
4500
 
@@ -3594,22 +4503,21 @@ Name | Type | Description | Notes
3594
4503
 
3595
4504
 
3596
4505
 
3597
- <a name="post_workforcemanagement_managementunit_timeoffrequests_query"></a>
4506
+ <a name="post_workforcemanagement_managementunit_week_schedules_generate"></a>
3598
4507
 
3599
- ## [**TimeOffRequestLookupList**](TimeOffRequestLookupList.html) post_workforcemanagement_managementunit_timeoffrequests_query(mu_id, opts)
4508
+ ## [**GenerateWeekScheduleResponse**](GenerateWeekScheduleResponse.html) post_workforcemanagement_managementunit_week_schedules_generate(management_unit_id, week_id, opts)
3600
4509
 
3601
4510
 
3602
4511
 
3603
- Gets the lookup ids to fetch the specified set of requests
4512
+ Generate a week schedule
3604
4513
 
3605
4514
 
3606
4515
 
3607
- Wraps POST /api/v2/workforcemanagement/managementunits/{muId}/timeoffrequests/query
4516
+ Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/generate
3608
4517
 
3609
4518
  Requires ANY permissions:
3610
4519
 
3611
- * wfm:timeOffRequest:administer
3612
- * wfm:timeOffRequest:view
4520
+ * wfm:schedule:generate
3613
4521
 
3614
4522
 
3615
4523
  ### Example
@@ -3629,18 +4537,20 @@ end
3629
4537
 
3630
4538
  api_instance = PureCloud::WorkforceManagementApi.new
3631
4539
 
3632
- mu_id = "mu_id_example" # String | The muId of the management unit, or 'mine' for the management unit of the logged-in user.
4540
+ 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.
4541
+
4542
+ week_id = "week_id_example" # String | First day of schedule week in yyyy-MM-dd format.
3633
4543
 
3634
4544
  opts = {
3635
- body: PureCloud::TimeOffRequestQueryBody.new # TimeOffRequestQueryBody | body
4545
+ body: PureCloud::GenerateWeekScheduleRequest.new # GenerateWeekScheduleRequest | body
3636
4546
  }
3637
4547
 
3638
4548
  begin
3639
- #Gets the lookup ids to fetch the specified set of requests
3640
- result = api_instance.post_workforcemanagement_managementunit_timeoffrequests_query(mu_id, opts)
4549
+ #Generate a week schedule
4550
+ result = api_instance.post_workforcemanagement_managementunit_week_schedules_generate(management_unit_id, week_id, opts)
3641
4551
  p result
3642
4552
  rescue PureCloud::ApiError => e
3643
- puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_timeoffrequests_query: #{e}"
4553
+ puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_schedules_generate: #{e}"
3644
4554
  end
3645
4555
  ```
3646
4556
 
@@ -3648,14 +4558,15 @@ end
3648
4558
 
3649
4559
  Name | Type | Description | Notes
3650
4560
  ------------- | ------------- | ------------- | -------------
3651
- **mu_id** | **String**| The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
3652
- **body** | [**TimeOffRequestQueryBody**](TimeOffRequestQueryBody.html)| body | [optional] |
4561
+ **management_unit_id** | **String**| The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
4562
+ **week_id** | **String**| First day of schedule week in yyyy-MM-dd format. | |
4563
+ **body** | [**GenerateWeekScheduleRequest**](GenerateWeekScheduleRequest.html)| body | [optional] |
3653
4564
  {: class="table table-striped"}
3654
4565
 
3655
4566
 
3656
4567
  ### Return type
3657
4568
 
3658
- [**TimeOffRequestLookupList**](TimeOffRequestLookupList.html)
4569
+ [**GenerateWeekScheduleResponse**](GenerateWeekScheduleResponse.html)
3659
4570
 
3660
4571
  ### HTTP request headers
3661
4572
 
@@ -3664,22 +4575,23 @@ Name | Type | Description | Notes
3664
4575
 
3665
4576
 
3666
4577
 
3667
- <a name="post_workforcemanagement_managementunit_week_schedule_copy"></a>
4578
+ <a name="post_workforcemanagement_managementunit_week_schedules_partialupload"></a>
3668
4579
 
3669
- ## [**AsyncWeekScheduleResponse**](AsyncWeekScheduleResponse.html) post_workforcemanagement_managementunit_week_schedule_copy(management_unit_id, week_id, schedule_id, opts)
4580
+ ## [**PartialUploadResponse**](PartialUploadResponse.html) post_workforcemanagement_managementunit_week_schedules_partialupload(management_unit_id, week_id, opts)
3670
4581
 
3671
4582
 
3672
4583
 
3673
- Copy a week schedule
4584
+ Partial upload of user schedules where activity count is greater than 17500
3674
4585
 
3675
4586
 
3676
4587
 
3677
- Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}/copy
4588
+ Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/partialupload
3678
4589
 
3679
4590
  Requires ANY permissions:
3680
4591
 
3681
4592
  * wfm:schedule:add
3682
4593
  * wfm:schedule:administer
4594
+ * wfm:schedule:edit
3683
4595
 
3684
4596
 
3685
4597
  ### Example
@@ -3703,20 +4615,16 @@ management_unit_id = "management_unit_id_example" # String | The ID of the manag
3703
4615
 
3704
4616
  week_id = "week_id_example" # String | First day of schedule week in yyyy-MM-dd format.
3705
4617
 
3706
- schedule_id = "schedule_id_example" # String | The ID of the schedule to copy from
3707
-
3708
4618
  opts = {
3709
- force_async: true, # BOOLEAN | Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
3710
- force_download_service: true, # BOOLEAN | Force the result of this operation to be sent via download service. For testing/app development purposes
3711
- body: PureCloud::CopyWeekScheduleRequest.new # CopyWeekScheduleRequest | body
4619
+ body: PureCloud::UserSchedulesPartialUploadRequest.new # UserSchedulesPartialUploadRequest | body
3712
4620
  }
3713
4621
 
3714
4622
  begin
3715
- #Copy a week schedule
3716
- result = api_instance.post_workforcemanagement_managementunit_week_schedule_copy(management_unit_id, week_id, schedule_id, opts)
4623
+ #Partial upload of user schedules where activity count is greater than 17500
4624
+ result = api_instance.post_workforcemanagement_managementunit_week_schedules_partialupload(management_unit_id, week_id, opts)
3717
4625
  p result
3718
4626
  rescue PureCloud::ApiError => e
3719
- puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_schedule_copy: #{e}"
4627
+ puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_schedules_partialupload: #{e}"
3720
4628
  end
3721
4629
  ```
3722
4630
 
@@ -3726,16 +4634,13 @@ Name | Type | Description | Notes
3726
4634
  ------------- | ------------- | ------------- | -------------
3727
4635
  **management_unit_id** | **String**| The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
3728
4636
  **week_id** | **String**| First day of schedule week in yyyy-MM-dd format. | |
3729
- **schedule_id** | **String**| The ID of the schedule to copy from | |
3730
- **force_async** | **BOOLEAN**| Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes | [optional] |
3731
- **force_download_service** | **BOOLEAN**| Force the result of this operation to be sent via download service. For testing/app development purposes | [optional] |
3732
- **body** | [**CopyWeekScheduleRequest**](CopyWeekScheduleRequest.html)| body | [optional] |
4637
+ **body** | [**UserSchedulesPartialUploadRequest**](UserSchedulesPartialUploadRequest.html)| body | [optional] |
3733
4638
  {: class="table table-striped"}
3734
4639
 
3735
4640
 
3736
4641
  ### Return type
3737
4642
 
3738
- [**AsyncWeekScheduleResponse**](AsyncWeekScheduleResponse.html)
4643
+ [**PartialUploadResponse**](PartialUploadResponse.html)
3739
4644
 
3740
4645
  ### HTTP request headers
3741
4646
 
@@ -3744,22 +4649,21 @@ Name | Type | Description | Notes
3744
4649
 
3745
4650
 
3746
4651
 
3747
- <a name="post_workforcemanagement_managementunit_week_schedule_reschedule"></a>
4652
+ <a name="post_workforcemanagement_managementunit_week_shifttrade_match"></a>
3748
4653
 
3749
- ## [**AsyncWeekScheduleResponse**](AsyncWeekScheduleResponse.html) post_workforcemanagement_managementunit_week_schedule_reschedule(management_unit_id, week_id, schedule_id, opts)
4654
+ ## [**MatchShiftTradeResponse**](MatchShiftTradeResponse.html) post_workforcemanagement_managementunit_week_shifttrade_match(management_unit_id, week_date_id, body, trade_id)
3750
4655
 
3751
4656
 
3752
4657
 
3753
- Start a scheduling run to compute the reschedule. When the scheduling run finishes, a client can get the reschedule changes and then the client can apply them to the schedule, save the schedule, and mark the scheduling run as applied
4658
+ Matches a shift trade. This route can only be called by the receiving agent
3754
4659
 
3755
4660
 
3756
4661
 
3757
- Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}/reschedule
4662
+ Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/{tradeId}/match
3758
4663
 
3759
4664
  Requires ANY permissions:
3760
4665
 
3761
- * wfm:schedule:administer
3762
- * wfm:schedule:edit
4666
+ * wfm:agentShiftTradeRequest:participate
3763
4667
 
3764
4668
 
3765
4669
  ### Example
@@ -3779,22 +4683,21 @@ end
3779
4683
 
3780
4684
  api_instance = PureCloud::WorkforceManagementApi.new
3781
4685
 
3782
- 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.
4686
+ management_unit_id = "management_unit_id_example" # String | The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
3783
4687
 
3784
- week_id = "week_id_example" # String | First day of schedule week in yyyy-MM-dd format.
4688
+ week_date_id = Date.parse("2013-10-20") # Date | The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
3785
4689
 
3786
- schedule_id = "schedule_id_example" # String | The ID of the schedule to re-optimize
4690
+ body = PureCloud::MatchShiftTradeRequest.new # MatchShiftTradeRequest | body
4691
+
4692
+ trade_id = "trade_id_example" # String | The ID of the shift trade to update
3787
4693
 
3788
- opts = {
3789
- body: PureCloud::RescheduleRequest.new # RescheduleRequest | body
3790
- }
3791
4694
 
3792
4695
  begin
3793
- #Start a scheduling run to compute the reschedule. When the scheduling run finishes, a client can get the reschedule changes and then the client can apply them to the schedule, save the schedule, and mark the scheduling run as applied
3794
- result = api_instance.post_workforcemanagement_managementunit_week_schedule_reschedule(management_unit_id, week_id, schedule_id, opts)
4696
+ #Matches a shift trade. This route can only be called by the receiving agent
4697
+ result = api_instance.post_workforcemanagement_managementunit_week_shifttrade_match(management_unit_id, week_date_id, body, trade_id)
3795
4698
  p result
3796
4699
  rescue PureCloud::ApiError => e
3797
- puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_schedule_reschedule: #{e}"
4700
+ puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_shifttrade_match: #{e}"
3798
4701
  end
3799
4702
  ```
3800
4703
 
@@ -3802,16 +4705,16 @@ end
3802
4705
 
3803
4706
  Name | Type | Description | Notes
3804
4707
  ------------- | ------------- | ------------- | -------------
3805
- **management_unit_id** | **String**| The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
3806
- **week_id** | **String**| First day of schedule week in yyyy-MM-dd format. | |
3807
- **schedule_id** | **String**| The ID of the schedule to re-optimize | |
3808
- **body** | [**RescheduleRequest**](RescheduleRequest.html)| body | [optional] |
4708
+ **management_unit_id** | **String**| The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
4709
+ **week_date_id** | **Date**| The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd | |
4710
+ **body** | [**MatchShiftTradeRequest**](MatchShiftTradeRequest.html)| body | |
4711
+ **trade_id** | **String**| The ID of the shift trade to update | |
3809
4712
  {: class="table table-striped"}
3810
4713
 
3811
4714
 
3812
4715
  ### Return type
3813
4716
 
3814
- [**AsyncWeekScheduleResponse**](AsyncWeekScheduleResponse.html)
4717
+ [**MatchShiftTradeResponse**](MatchShiftTradeResponse.html)
3815
4718
 
3816
4719
  ### HTTP request headers
3817
4720
 
@@ -3820,22 +4723,21 @@ Name | Type | Description | Notes
3820
4723
 
3821
4724
 
3822
4725
 
3823
- <a name="post_workforcemanagement_managementunit_week_schedules"></a>
4726
+ <a name="post_workforcemanagement_managementunit_week_shifttrade_update"></a>
3824
4727
 
3825
- ## [**AsyncWeekScheduleResponse**](AsyncWeekScheduleResponse.html) post_workforcemanagement_managementunit_week_schedules(management_unit_id, week_id, opts)
4728
+ ## [**ShiftTradeResponse**](ShiftTradeResponse.html) post_workforcemanagement_managementunit_week_shifttrade_update(management_unit_id, week_date_id, body, trade_id)
3826
4729
 
3827
4730
 
3828
4731
 
3829
- Add a schedule for a week in management unit using imported data. Use partial uploads of user schedules if activity count in schedule is greater than 17500
4732
+ Updates a shift trade. This route can only be called by the initiating agent
3830
4733
 
3831
4734
 
3832
4735
 
3833
- Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules
4736
+ Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/{tradeId}/update
3834
4737
 
3835
4738
  Requires ANY permissions:
3836
4739
 
3837
- * wfm:schedule:add
3838
- * wfm:schedule:administer
4740
+ * wfm:agentShiftTradeRequest:participate
3839
4741
 
3840
4742
 
3841
4743
  ### Example
@@ -3855,22 +4757,21 @@ end
3855
4757
 
3856
4758
  api_instance = PureCloud::WorkforceManagementApi.new
3857
4759
 
3858
- 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.
4760
+ management_unit_id = "management_unit_id_example" # String | The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
3859
4761
 
3860
- week_id = "week_id_example" # String | First day of schedule week in yyyy-MM-dd format.
4762
+ week_date_id = Date.parse("2013-10-20") # Date | The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
4763
+
4764
+ body = PureCloud::UpdateShiftTradeRequest.new # UpdateShiftTradeRequest | body
4765
+
4766
+ trade_id = "trade_id_example" # String | The ID of the shift trade to update
3861
4767
 
3862
- opts = {
3863
- force_async: true, # BOOLEAN | Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
3864
- force_download_service: true, # BOOLEAN | Force the result of this operation to be sent via download service. For testing/app development purposes
3865
- body: PureCloud::ImportWeekScheduleRequest.new # ImportWeekScheduleRequest | body
3866
- }
3867
4768
 
3868
4769
  begin
3869
- #Add a schedule for a week in management unit using imported data. Use partial uploads of user schedules if activity count in schedule is greater than 17500
3870
- result = api_instance.post_workforcemanagement_managementunit_week_schedules(management_unit_id, week_id, opts)
4770
+ #Updates a shift trade. This route can only be called by the initiating agent
4771
+ result = api_instance.post_workforcemanagement_managementunit_week_shifttrade_update(management_unit_id, week_date_id, body, trade_id)
3871
4772
  p result
3872
4773
  rescue PureCloud::ApiError => e
3873
- puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_schedules: #{e}"
4774
+ puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_shifttrade_update: #{e}"
3874
4775
  end
3875
4776
  ```
3876
4777
 
@@ -3878,17 +4779,16 @@ end
3878
4779
 
3879
4780
  Name | Type | Description | Notes
3880
4781
  ------------- | ------------- | ------------- | -------------
3881
- **management_unit_id** | **String**| The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
3882
- **week_id** | **String**| First day of schedule week in yyyy-MM-dd format. | |
3883
- **force_async** | **BOOLEAN**| Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes | [optional] |
3884
- **force_download_service** | **BOOLEAN**| Force the result of this operation to be sent via download service. For testing/app development purposes | [optional] |
3885
- **body** | [**ImportWeekScheduleRequest**](ImportWeekScheduleRequest.html)| body | [optional] |
4782
+ **management_unit_id** | **String**| The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
4783
+ **week_date_id** | **Date**| The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd | |
4784
+ **body** | [**UpdateShiftTradeRequest**](UpdateShiftTradeRequest.html)| body | |
4785
+ **trade_id** | **String**| The ID of the shift trade to update | |
3886
4786
  {: class="table table-striped"}
3887
4787
 
3888
4788
 
3889
4789
  ### Return type
3890
4790
 
3891
- [**AsyncWeekScheduleResponse**](AsyncWeekScheduleResponse.html)
4791
+ [**ShiftTradeResponse**](ShiftTradeResponse.html)
3892
4792
 
3893
4793
  ### HTTP request headers
3894
4794
 
@@ -3897,21 +4797,21 @@ Name | Type | Description | Notes
3897
4797
 
3898
4798
 
3899
4799
 
3900
- <a name="post_workforcemanagement_managementunit_week_schedules_generate"></a>
4800
+ <a name="post_workforcemanagement_managementunit_week_shifttrades"></a>
3901
4801
 
3902
- ## [**GenerateWeekScheduleResponse**](GenerateWeekScheduleResponse.html) post_workforcemanagement_managementunit_week_schedules_generate(management_unit_id, week_id, opts)
4802
+ ## [**ShiftTradeResponse**](ShiftTradeResponse.html) post_workforcemanagement_managementunit_week_shifttrades(management_unit_id, week_date_id, body)
3903
4803
 
3904
4804
 
3905
4805
 
3906
- Generate a week schedule
4806
+ Adds a shift trade
3907
4807
 
3908
4808
 
3909
4809
 
3910
- Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/generate
4810
+ Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades
3911
4811
 
3912
4812
  Requires ANY permissions:
3913
4813
 
3914
- * wfm:schedule:generate
4814
+ * wfm:agentShiftTradeRequest:participate
3915
4815
 
3916
4816
 
3917
4817
  ### Example
@@ -3931,20 +4831,19 @@ end
3931
4831
 
3932
4832
  api_instance = PureCloud::WorkforceManagementApi.new
3933
4833
 
3934
- 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.
4834
+ management_unit_id = "management_unit_id_example" # String | The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
3935
4835
 
3936
- week_id = "week_id_example" # String | First day of schedule week in yyyy-MM-dd format.
4836
+ week_date_id = Date.parse("2013-10-20") # Date | The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
4837
+
4838
+ body = PureCloud::AddShiftTradeRequest.new # AddShiftTradeRequest | body
3937
4839
 
3938
- opts = {
3939
- body: PureCloud::GenerateWeekScheduleRequest.new # GenerateWeekScheduleRequest | body
3940
- }
3941
4840
 
3942
4841
  begin
3943
- #Generate a week schedule
3944
- result = api_instance.post_workforcemanagement_managementunit_week_schedules_generate(management_unit_id, week_id, opts)
4842
+ #Adds a shift trade
4843
+ result = api_instance.post_workforcemanagement_managementunit_week_shifttrades(management_unit_id, week_date_id, body)
3945
4844
  p result
3946
4845
  rescue PureCloud::ApiError => e
3947
- puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_schedules_generate: #{e}"
4846
+ puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_shifttrades: #{e}"
3948
4847
  end
3949
4848
  ```
3950
4849
 
@@ -3952,15 +4851,15 @@ end
3952
4851
 
3953
4852
  Name | Type | Description | Notes
3954
4853
  ------------- | ------------- | ------------- | -------------
3955
- **management_unit_id** | **String**| The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
3956
- **week_id** | **String**| First day of schedule week in yyyy-MM-dd format. | |
3957
- **body** | [**GenerateWeekScheduleRequest**](GenerateWeekScheduleRequest.html)| body | [optional] |
4854
+ **management_unit_id** | **String**| The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
4855
+ **week_date_id** | **Date**| The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd | |
4856
+ **body** | [**AddShiftTradeRequest**](AddShiftTradeRequest.html)| body | |
3958
4857
  {: class="table table-striped"}
3959
4858
 
3960
4859
 
3961
4860
  ### Return type
3962
4861
 
3963
- [**GenerateWeekScheduleResponse**](GenerateWeekScheduleResponse.html)
4862
+ [**ShiftTradeResponse**](ShiftTradeResponse.html)
3964
4863
 
3965
4864
  ### HTTP request headers
3966
4865
 
@@ -3969,23 +4868,21 @@ Name | Type | Description | Notes
3969
4868
 
3970
4869
 
3971
4870
 
3972
- <a name="post_workforcemanagement_managementunit_week_schedules_partialupload"></a>
4871
+ <a name="post_workforcemanagement_managementunit_week_shifttrades_search"></a>
3973
4872
 
3974
- ## [**PartialUploadResponse**](PartialUploadResponse.html) post_workforcemanagement_managementunit_week_schedules_partialupload(management_unit_id, week_id, opts)
4873
+ ## [**SearchShiftTradesResponse**](SearchShiftTradesResponse.html) post_workforcemanagement_managementunit_week_shifttrades_search(management_unit_id, week_date_id, body)
3975
4874
 
3976
4875
 
3977
4876
 
3978
- Partial upload of user schedules where activity count is greater than 17500
4877
+ Searches for potential shift trade matches for the current agent
3979
4878
 
3980
4879
 
3981
4880
 
3982
- Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/partialupload
4881
+ Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/search
3983
4882
 
3984
4883
  Requires ANY permissions:
3985
4884
 
3986
- * wfm:schedule:add
3987
- * wfm:schedule:administer
3988
- * wfm:schedule:edit
4885
+ * wfm:agentShiftTradeRequest:participate
3989
4886
 
3990
4887
 
3991
4888
  ### Example
@@ -4005,20 +4902,19 @@ end
4005
4902
 
4006
4903
  api_instance = PureCloud::WorkforceManagementApi.new
4007
4904
 
4008
- 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.
4905
+ management_unit_id = "management_unit_id_example" # String | The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
4009
4906
 
4010
- week_id = "week_id_example" # String | First day of schedule week in yyyy-MM-dd format.
4907
+ week_date_id = Date.parse("2013-10-20") # Date | The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
4908
+
4909
+ body = PureCloud::SearchShiftTradesRequest.new # SearchShiftTradesRequest | body
4011
4910
 
4012
- opts = {
4013
- body: PureCloud::UserSchedulesPartialUploadRequest.new # UserSchedulesPartialUploadRequest | body
4014
- }
4015
4911
 
4016
4912
  begin
4017
- #Partial upload of user schedules where activity count is greater than 17500
4018
- result = api_instance.post_workforcemanagement_managementunit_week_schedules_partialupload(management_unit_id, week_id, opts)
4913
+ #Searches for potential shift trade matches for the current agent
4914
+ result = api_instance.post_workforcemanagement_managementunit_week_shifttrades_search(management_unit_id, week_date_id, body)
4019
4915
  p result
4020
4916
  rescue PureCloud::ApiError => e
4021
- puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_schedules_partialupload: #{e}"
4917
+ puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_shifttrades_search: #{e}"
4022
4918
  end
4023
4919
  ```
4024
4920
 
@@ -4026,15 +4922,15 @@ end
4026
4922
 
4027
4923
  Name | Type | Description | Notes
4028
4924
  ------------- | ------------- | ------------- | -------------
4029
- **management_unit_id** | **String**| The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
4030
- **week_id** | **String**| First day of schedule week in yyyy-MM-dd format. | |
4031
- **body** | [**UserSchedulesPartialUploadRequest**](UserSchedulesPartialUploadRequest.html)| body | [optional] |
4925
+ **management_unit_id** | **String**| The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
4926
+ **week_date_id** | **Date**| The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd | |
4927
+ **body** | [**SearchShiftTradesRequest**](SearchShiftTradesRequest.html)| body | |
4032
4928
  {: class="table table-striped"}
4033
4929
 
4034
4930
 
4035
4931
  ### Return type
4036
4932
 
4037
- [**PartialUploadResponse**](PartialUploadResponse.html)
4933
+ [**SearchShiftTradesResponse**](SearchShiftTradesResponse.html)
4038
4934
 
4039
4935
  ### HTTP request headers
4040
4936
 
@@ -4556,6 +5452,71 @@ Name | Type | Description | Notes
4556
5452
 
4557
5453
 
4558
5454
 
5455
+ <a name="post_workforcemanagement_notifications_update"></a>
5456
+
5457
+ ## [**UpdateNotificationsResponse**](UpdateNotificationsResponse.html) post_workforcemanagement_notifications_update(opts)
5458
+
5459
+
5460
+
5461
+ Mark a list of notifications as read or unread
5462
+
5463
+
5464
+
5465
+ Wraps POST /api/v2/workforcemanagement/notifications/update
5466
+
5467
+ Requires NO permissions:
5468
+
5469
+
5470
+
5471
+ ### Example
5472
+ ```{"language":"ruby"}
5473
+ # load the gem
5474
+ require 'purecloudplatformclientv2'
5475
+ # setup authorization
5476
+ @secret = ENV['PURECLOUD_SECRET']
5477
+ @id = ENV['PURECLOUD_CLIENT_ID']
5478
+ environment = "mypurecloud.com"
5479
+
5480
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
5481
+
5482
+ PureCloud.configure do |config|
5483
+ config.access_token = @authToken
5484
+ end
5485
+
5486
+ api_instance = PureCloud::WorkforceManagementApi.new
5487
+
5488
+ opts = {
5489
+ body: PureCloud::UpdateNotificationsRequest.new # UpdateNotificationsRequest | body
5490
+ }
5491
+
5492
+ begin
5493
+ #Mark a list of notifications as read or unread
5494
+ result = api_instance.post_workforcemanagement_notifications_update(opts)
5495
+ p result
5496
+ rescue PureCloud::ApiError => e
5497
+ puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_notifications_update: #{e}"
5498
+ end
5499
+ ```
5500
+
5501
+ ### Parameters
5502
+
5503
+ Name | Type | Description | Notes
5504
+ ------------- | ------------- | ------------- | -------------
5505
+ **body** | [**UpdateNotificationsRequest**](UpdateNotificationsRequest.html)| body | [optional] |
5506
+ {: class="table table-striped"}
5507
+
5508
+
5509
+ ### Return type
5510
+
5511
+ [**UpdateNotificationsResponse**](UpdateNotificationsResponse.html)
5512
+
5513
+ ### HTTP request headers
5514
+
5515
+ - **Content-Type**: application/json
5516
+ - **Accept**: application/json
5517
+
5518
+
5519
+
4559
5520
  <a name="post_workforcemanagement_schedules"></a>
4560
5521
 
4561
5522
  ## [**UserScheduleContainer**](UserScheduleContainer.html) post_workforcemanagement_schedules(opts)
@@ -4690,3 +5651,78 @@ Name | Type | Description | Notes
4690
5651
 
4691
5652
 
4692
5653
 
5654
+ <a name="put_workforcemanagement_managementunit_week_shifttrade_state"></a>
5655
+
5656
+ ## [**ShiftTradeResponse**](ShiftTradeResponse.html) put_workforcemanagement_managementunit_week_shifttrade_state(management_unit_id, week_date_id, trade_id, body)
5657
+
5658
+
5659
+
5660
+ Updates a shift trade state
5661
+
5662
+
5663
+
5664
+ Wraps PUT /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/{tradeId}/state
5665
+
5666
+ Requires ANY permissions:
5667
+
5668
+ * wfm:agentShiftTradeRequest:participate
5669
+ * wfm:shiftTradeRequest:edit
5670
+
5671
+
5672
+ ### Example
5673
+ ```{"language":"ruby"}
5674
+ # load the gem
5675
+ require 'purecloudplatformclientv2'
5676
+ # setup authorization
5677
+ @secret = ENV['PURECLOUD_SECRET']
5678
+ @id = ENV['PURECLOUD_CLIENT_ID']
5679
+ environment = "mypurecloud.com"
5680
+
5681
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
5682
+
5683
+ PureCloud.configure do |config|
5684
+ config.access_token = @authToken
5685
+ end
5686
+
5687
+ api_instance = PureCloud::WorkforceManagementApi.new
5688
+
5689
+ management_unit_id = "management_unit_id_example" # String | The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
5690
+
5691
+ week_date_id = Date.parse("2013-10-20") # Date | The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
5692
+
5693
+ trade_id = "trade_id_example" # String | The ID of the shift trade to update
5694
+
5695
+ body = PureCloud::UpdateShiftTradeStateRequest.new # UpdateShiftTradeStateRequest | body
5696
+
5697
+
5698
+ begin
5699
+ #Updates a shift trade state
5700
+ result = api_instance.put_workforcemanagement_managementunit_week_shifttrade_state(management_unit_id, week_date_id, trade_id, body)
5701
+ p result
5702
+ rescue PureCloud::ApiError => e
5703
+ puts "Exception when calling WorkforceManagementApi->put_workforcemanagement_managementunit_week_shifttrade_state: #{e}"
5704
+ end
5705
+ ```
5706
+
5707
+ ### Parameters
5708
+
5709
+ Name | Type | Description | Notes
5710
+ ------------- | ------------- | ------------- | -------------
5711
+ **management_unit_id** | **String**| The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
5712
+ **week_date_id** | **Date**| The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd | |
5713
+ **trade_id** | **String**| The ID of the shift trade to update | |
5714
+ **body** | [**UpdateShiftTradeStateRequest**](UpdateShiftTradeStateRequest.html)| body | |
5715
+ {: class="table table-striped"}
5716
+
5717
+
5718
+ ### Return type
5719
+
5720
+ [**ShiftTradeResponse**](ShiftTradeResponse.html)
5721
+
5722
+ ### HTTP request headers
5723
+
5724
+ - **Content-Type**: application/json
5725
+ - **Accept**: application/json
5726
+
5727
+
5728
+