purecloudplatformclientv2 84.0.0 → 85.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 (662) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/docs/ActionEntityListing.md +2 -2
  4. data/docs/AddShiftTradeRequest.md +17 -0
  5. data/docs/AdditionalMessage.md +1 -0
  6. data/docs/AgentActivityEntityListing.md +2 -2
  7. data/docs/AnalyticsConversationAsyncQueryResponse.md +1 -0
  8. data/docs/AnalyticsUserDetailsAsyncQueryResponse.md +1 -0
  9. data/docs/ArchitectApi.md +5 -1
  10. data/docs/ArrayNode.md +2 -2
  11. data/docs/AsyncForecastOperationResult.md +16 -0
  12. data/docs/AsyncIntradayResponse.md +15 -0
  13. data/docs/AttemptLimitsEntityListing.md +2 -2
  14. data/docs/AuthorizationApi.md +0 -72
  15. data/docs/AuthzDivisionEntityListing.md +2 -2
  16. data/docs/BillingApi.md +0 -2
  17. data/docs/BuAbandonRate.md +14 -0
  18. data/docs/BuAgentScheduleQueryResponse.md +17 -0
  19. data/docs/BuAgentScheduleRescheduleResponse.md +16 -0
  20. data/docs/BuAgentScheduleUpdate.md +14 -0
  21. data/docs/BuAgentSchedulesQueryResponse.md +13 -0
  22. data/docs/BuAsyncAgentSchedulesQueryResponse.md +17 -0
  23. data/docs/BuAsyncScheduleResponse.md +15 -0
  24. data/docs/BuAsyncScheduleRunResponse.md +15 -0
  25. data/docs/BuAverageSpeedOfAnswer.md +14 -0
  26. data/docs/BuCopyScheduleRequest.md +14 -0
  27. data/docs/BuCreateBlankScheduleRequest.md +15 -0
  28. data/docs/BuCurrentAgentScheduleSearchResponse.md +18 -0
  29. data/docs/BuForecastGenerationPlanningGroupResult.md +14 -0
  30. data/docs/BuForecastGenerationResult.md +13 -0
  31. data/docs/BuForecastModification.md +23 -0
  32. data/docs/BuForecastResult.md +16 -0
  33. data/docs/BuForecastResultResponse.md +14 -0
  34. data/docs/BuForecastTimeSeriesResult.md +14 -0
  35. data/docs/BuGenerateScheduleRequest.md +15 -0
  36. data/docs/BuGetCurrentAgentScheduleRequest.md +14 -0
  37. data/docs/BuHeadcountForecast.md +14 -0
  38. data/docs/BuHeadcountForecastResponse.md +14 -0
  39. data/docs/BuIntradayDataGroup.md +19 -0
  40. data/docs/BuIntradayForecastData.md +14 -0
  41. data/docs/BuIntradayResponse.md +20 -0
  42. data/docs/BuIntradayScheduleData.md +13 -0
  43. data/docs/BuManagementUnitScheduleSummary.md +17 -0
  44. data/docs/BuPlanningGroupHeadcountForecast.md +15 -0
  45. data/docs/BuQueryAgentSchedulesRequest.md +14 -0
  46. data/docs/BuRescheduleAgentScheduleResult.md +15 -0
  47. data/docs/BuRescheduleRequest.md +21 -0
  48. data/docs/BuRescheduleResult.md +17 -0
  49. data/docs/BuScheduleListItem.md +21 -0
  50. data/docs/BuScheduleListing.md +13 -0
  51. data/docs/BuScheduleMetadata.md +22 -0
  52. data/docs/BuScheduleReferenceForMuRoute.md +16 -0
  53. data/docs/BuScheduleRun.md +29 -0
  54. data/docs/BuScheduleRunListing.md +13 -0
  55. data/docs/BuServiceLevel.md +15 -0
  56. data/docs/BuShortTermForecast.md +27 -0
  57. data/docs/BuShortTermForecastListItem.md +20 -0
  58. data/docs/BuShortTermForecastListing.md +13 -0
  59. data/docs/BuShortTermForecastReference.md +16 -0
  60. data/docs/BuShortTermForecastingSettings.md +13 -0
  61. data/docs/BulkShiftTradeStateUpdateRequest.md +13 -0
  62. data/docs/BulkUpdateShiftTradeStateRequestItem.md +15 -0
  63. data/docs/BulkUpdateShiftTradeStateResponse.md +15 -0
  64. data/docs/BulkUpdateShiftTradeStateResult.md +13 -0
  65. data/docs/BulkUpdateShiftTradeStateResultItem.md +18 -0
  66. data/docs/BusinessUnit.md +17 -0
  67. data/docs/BusinessUnitActivityCode.md +23 -0
  68. data/docs/BusinessUnitActivityCodeListing.md +13 -0
  69. data/docs/BusinessUnitListItem.md +17 -0
  70. data/docs/BusinessUnitListing.md +13 -0
  71. data/docs/BusinessUnitSettings.md +16 -0
  72. data/docs/CalibrationEntityListing.md +2 -2
  73. data/docs/CallConversationEntityListing.md +2 -2
  74. data/docs/CallHistoryConversationEntityListing.md +2 -2
  75. data/docs/CallableTimeSetEntityListing.md +2 -2
  76. data/docs/Callback.md +1 -0
  77. data/docs/CallbackBasic.md +1 -0
  78. data/docs/CallbackConversationEntityListing.md +2 -2
  79. data/docs/CallbackMediaParticipant.md +2 -1
  80. data/docs/CampaignDivisionViewListing.md +2 -2
  81. data/docs/CampaignEntityListing.md +2 -2
  82. data/docs/CampaignRuleEntityListing.md +2 -2
  83. data/docs/CampaignSequenceEntityListing.md +2 -2
  84. data/docs/CategoryListing.md +16 -0
  85. data/docs/CertificateAuthorityEntityListing.md +2 -2
  86. data/docs/ChatConversationEntityListing.md +2 -2
  87. data/docs/ClientAppEntityListing.md +2 -2
  88. data/docs/CobrowseConversationEntityListing.md +2 -2
  89. data/docs/CommandStatusEntityListing.md +2 -2
  90. data/docs/ConsumedResourcesEntityListing.md +2 -2
  91. data/docs/ConsumingResourcesEntityListing.md +2 -2
  92. data/docs/ContactListDivisionViewListing.md +2 -2
  93. data/docs/ContactListEntityListing.md +2 -2
  94. data/docs/ContactListFilterEntityListing.md +2 -2
  95. data/docs/ContactListing.md +2 -2
  96. data/docs/ConversationEntityListing.md +2 -2
  97. data/docs/ConversationsApi.md +1 -1
  98. data/docs/CopyBuForecastRequest.md +14 -0
  99. data/docs/CreateBusinessUnitRequest.md +15 -0
  100. data/docs/CreateBusinessUnitSettings.md +15 -0
  101. data/docs/CreatePlanningGroupRequest.md +15 -0
  102. data/docs/CreateServiceGoalTemplate.md +16 -0
  103. data/docs/CredentialInfoListing.md +2 -2
  104. data/docs/CredentialTypeListing.md +2 -2
  105. data/docs/Cursors.md +14 -0
  106. data/docs/DIDEntityListing.md +2 -2
  107. data/docs/DIDPoolEntityListing.md +2 -2
  108. data/docs/DataTableRowEntityListing.md +2 -2
  109. data/docs/DataTablesDomainEntityListing.md +2 -2
  110. data/docs/DependencyObjectEntityListing.md +2 -2
  111. data/docs/DependencyTypeEntityListing.md +2 -2
  112. data/docs/DialerEventEntityListing.md +2 -2
  113. data/docs/DialogflowAgentSummaryEntityListing.md +2 -2
  114. data/docs/DirectoryUserDevicesListing.md +2 -2
  115. data/docs/DivsPermittedEntityListing.md +2 -2
  116. data/docs/DncListDivisionViewListing.md +2 -2
  117. data/docs/DncListEntityListing.md +2 -2
  118. data/docs/DocumentAuditEntityListing.md +2 -2
  119. data/docs/DocumentCategoryInput.md +13 -0
  120. data/docs/DocumentEntityListing.md +2 -2
  121. data/docs/DocumentFaq.md +15 -0
  122. data/docs/DocumentListing.md +16 -0
  123. data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +2 -2
  124. data/docs/DomainEntityListing.md +2 -2
  125. data/docs/DomainEntityListingEvaluationForm.md +2 -2
  126. data/docs/DomainEntityListingQueryResult.md +2 -2
  127. data/docs/DomainEntityListingSurveyForm.md +2 -2
  128. data/docs/EdgeEntityListing.md +2 -2
  129. data/docs/EdgeGroupEntityListing.md +2 -2
  130. data/docs/EdgeLineEntityListing.md +2 -2
  131. data/docs/EmailConversationEntityListing.md +2 -2
  132. data/docs/EmailMessageListing.md +2 -2
  133. data/docs/EmergencyGroupListing.md +2 -2
  134. data/docs/EncryptionKeyEntityListing.md +2 -2
  135. data/docs/EntityListing.md +5 -1
  136. data/docs/EvaluationEntityListing.md +2 -2
  137. data/docs/EvaluationFormEntityListing.md +2 -2
  138. data/docs/EvaluatorActivityEntityListing.md +2 -2
  139. data/docs/ExtensionEntityListing.md +2 -2
  140. data/docs/ExtensionPoolEntityListing.md +2 -2
  141. data/docs/ExternalContactsApi.md +2 -2
  142. data/docs/ExternalOrganizationListing.md +2 -2
  143. data/docs/ExternalOrganizationTrustorLink.md +17 -0
  144. data/docs/FacebookIntegrationEntityListing.md +2 -2
  145. data/docs/FaxDocumentEntityListing.md +2 -2
  146. data/docs/FlowDivisionViewEntityListing.md +2 -2
  147. data/docs/FlowEntityListing.md +2 -2
  148. data/docs/FlowOutcomeListing.md +2 -2
  149. data/docs/FlowVersionEntityListing.md +2 -2
  150. data/docs/ForecastAbandonRateResponse.md +13 -0
  151. data/docs/ForecastAverageSpeedOfAnswerResponse.md +13 -0
  152. data/docs/ForecastPlanningGroupData.md +15 -0
  153. data/docs/ForecastPlanningGroupResponse.md +16 -0
  154. data/docs/ForecastPlanningGroupsResponse.md +13 -0
  155. data/docs/ForecastServiceGoalTemplateResponse.md +15 -0
  156. data/docs/ForecastServiceLevelResponse.md +14 -0
  157. data/docs/GDPRRequestEntityListing.md +2 -2
  158. data/docs/GDPRSubjectEntityListing.md +2 -2
  159. data/docs/GenerateBuForecastRequest.md +14 -0
  160. data/docs/GreetingListing.md +2 -2
  161. data/docs/GroupEntityListing.md +2 -2
  162. data/docs/GroupProfileEntityListing.md +2 -2
  163. data/docs/IVREntityListing.md +2 -2
  164. data/docs/InboundDomainEntityListing.md +2 -2
  165. data/docs/InboundDomainPatchRequest.md +14 -0
  166. data/docs/InboundRouteEntityListing.md +2 -2
  167. data/docs/IntegrationEntityListing.md +2 -2
  168. data/docs/IntegrationEventEntityListing.md +2 -2
  169. data/docs/IntegrationTypeEntityListing.md +2 -2
  170. data/docs/InteractionStatsAlertContainer.md +2 -2
  171. data/docs/InteractionStatsRuleContainer.md +2 -2
  172. data/docs/IntradayPerformancePredictionData.md +15 -0
  173. data/docs/IntradayPlanningGroupRequest.md +16 -0
  174. data/docs/JsonNode.md +2 -2
  175. data/docs/KeywordSetEntityListing.md +2 -2
  176. data/docs/KnowledgeApi.md +1528 -0
  177. data/docs/KnowledgeBase.md +19 -0
  178. data/docs/KnowledgeBaseListing.md +16 -0
  179. data/docs/KnowledgeCategory.md +20 -0
  180. data/docs/KnowledgeCategoryRequest.md +17 -0
  181. data/docs/KnowledgeDocument.md +23 -0
  182. data/docs/KnowledgeDocumentBulkRequest.md +17 -0
  183. data/docs/KnowledgeDocumentRequest.md +16 -0
  184. data/docs/KnowledgeExtendedCategory.md +22 -0
  185. data/docs/KnowledgeSearchDocument.md +24 -0
  186. data/docs/KnowledgeSearchRequest.md +18 -0
  187. data/docs/KnowledgeSearchResponse.md +18 -0
  188. data/docs/KnowledgeTraining.md +23 -0
  189. data/docs/LanguageEntityListing.md +2 -2
  190. data/docs/LexBotAliasEntityListing.md +2 -2
  191. data/docs/LexBotEntityListing.md +2 -2
  192. data/docs/LibraryEntityListing.md +2 -2
  193. data/docs/LineBaseEntityListing.md +2 -2
  194. data/docs/LineEntityListing.md +2 -2
  195. data/docs/LineIntegrationEntityListing.md +2 -2
  196. data/docs/ListWrapperInterval.md +13 -0
  197. data/docs/LocationEntityListing.md +2 -2
  198. data/docs/LogicalInterfaceEntityListing.md +2 -2
  199. data/docs/ManagementUnitListing.md +2 -2
  200. data/docs/MatchShiftTradeRequest.md +15 -0
  201. data/docs/MatchShiftTradeResponse.md +15 -0
  202. data/docs/MessageConversationEntityListing.md +2 -2
  203. data/docs/MessagingIntegrationEntityListing.md +2 -2
  204. data/docs/MessagingStickerEntityListing.md +2 -2
  205. data/docs/MessagingTemplateRequest.md +14 -0
  206. data/docs/MuRescheduleResultWrapper.md +13 -0
  207. data/docs/NoteListing.md +2 -2
  208. data/docs/OAuthClientEntityListing.md +2 -2
  209. data/docs/OAuthProviderEntityListing.md +2 -2
  210. data/docs/OrganizationPresenceEntityListing.md +2 -2
  211. data/docs/OrganizationRoleEntityListing.md +2 -2
  212. data/docs/OrphanRecordingListing.md +2 -2
  213. data/docs/OutboundRouteBaseEntityListing.md +2 -2
  214. data/docs/OutboundRouteEntityListing.md +2 -2
  215. data/docs/PatchBuReschedulingOptionsManagementUnitRequest.md +14 -0
  216. data/docs/PatchBuReschedulingOptionsRequest.md +13 -0
  217. data/docs/PatchBuScheduleRunRequest.md +13 -0
  218. data/docs/PatchShiftTradeRequest.md +16 -0
  219. data/docs/PermissionCollectionEntityListing.md +2 -2
  220. data/docs/PhoneBaseEntityListing.md +2 -2
  221. data/docs/PhoneEntityListing.md +2 -2
  222. data/docs/PhoneMetaBaseEntityListing.md +2 -2
  223. data/docs/PhysicalInterfaceEntityListing.md +2 -2
  224. data/docs/PlanningGroup.md +18 -0
  225. data/docs/PlanningGroupList.md +13 -0
  226. data/docs/PlanningGroupReference.md +14 -0
  227. data/docs/PolicyEntityListing.md +2 -2
  228. data/docs/PromptAssetEntityListing.md +2 -2
  229. data/docs/PromptEntityListing.md +2 -2
  230. data/docs/QualityAuditPage.md +2 -2
  231. data/docs/QueueEntityListing.md +2 -2
  232. data/docs/QueueMemberEntityListing.md +2 -2
  233. data/docs/RecipientListing.md +2 -2
  234. data/docs/RecordingApi.md +12 -6
  235. data/docs/RecordingJobEntityListing.md +2 -2
  236. data/docs/RelationshipListing.md +2 -2
  237. data/docs/ReportMetaDataEntityListing.md +2 -2
  238. data/docs/ReportRunEntryEntityDomainListing.md +2 -2
  239. data/docs/ReportScheduleEntityListing.md +2 -2
  240. data/docs/ReportingExportJobListing.md +2 -2
  241. data/docs/ReportingExportMetadataJobListing.md +2 -2
  242. data/docs/ReschedulingManagementUnitResponse.md +14 -0
  243. data/docs/ReschedulingOptionsRunResponse.md +22 -0
  244. data/docs/ResponseEntityList.md +2 -2
  245. data/docs/ResponseEntityListing.md +2 -2
  246. data/docs/ResponseSetEntityListing.md +2 -2
  247. data/docs/RoutePathRequest.md +17 -0
  248. data/docs/RoutePathResponse.md +16 -0
  249. data/docs/RoutingApi.md +139 -0
  250. data/docs/RuleSetEntityListing.md +2 -2
  251. data/docs/ScheduleEntityListing.md +2 -2
  252. data/docs/ScheduleGenerationMessage.md +14 -0
  253. data/docs/ScheduleGenerationResult.md +16 -0
  254. data/docs/ScheduleGenerationResultSummary.md +15 -0
  255. data/docs/ScheduleGroupEntityListing.md +2 -2
  256. data/docs/SchedulerMessageArgument.md +14 -0
  257. data/docs/SchedulingTestingOptionsRequest.md +16 -0
  258. data/docs/SchemaCategoryEntityListing.md +2 -2
  259. data/docs/SchemaReferenceEntityListing.md +2 -2
  260. data/docs/ScreenRecordingSessionListing.md +2 -2
  261. data/docs/ScriptEntityListing.md +2 -2
  262. data/docs/SearchApi.md +70 -0
  263. data/docs/SearchShiftTradeResponse.md +15 -0
  264. data/docs/SearchShiftTradesRequest.md +14 -0
  265. data/docs/SearchShiftTradesResponse.md +13 -0
  266. data/docs/SecurityProfileEntityListing.md +2 -2
  267. data/docs/ServiceGoalTemplate.md +19 -0
  268. data/docs/ServiceGoalTemplateList.md +13 -0
  269. data/docs/ServiceGoalTemplateReference.md +14 -0
  270. data/docs/SetWrapperRoutePathRequest.md +13 -0
  271. data/docs/ShareEntityListing.md +2 -2
  272. data/docs/ShiftTradeActivityPreviewResponse.md +16 -0
  273. data/docs/ShiftTradeMatchReviewResponse.md +16 -0
  274. data/docs/ShiftTradeMatchReviewUserResponse.md +17 -0
  275. data/docs/ShiftTradeMatchViolation.md +14 -0
  276. data/docs/ShiftTradePreviewResponse.md +13 -0
  277. data/docs/ShiftTradeResponse.md +1 -1
  278. data/docs/SiteEntityListing.md +2 -2
  279. data/docs/SkillEntityListing.md +2 -2
  280. data/docs/SmsAddressEntityListing.md +2 -2
  281. data/docs/SmsPhoneNumberEntityListing.md +2 -2
  282. data/docs/SourcePlanningGroupRequest.md +14 -0
  283. data/docs/StationEntityListing.md +2 -2
  284. data/docs/SubjectDivisionGrantsEntityListing.md +2 -2
  285. data/docs/SurveyFormEntityListing.md +2 -2
  286. data/docs/SystemPromptAssetEntityListing.md +2 -2
  287. data/docs/SystemPromptEntityListing.md +2 -2
  288. data/docs/TagValueEntityListing.md +2 -2
  289. data/docs/TemplateParameter.md +14 -0
  290. data/docs/TestMessage.md +19 -0
  291. data/docs/TextMessageListing.md +2 -2
  292. data/docs/TimeZoneEntityListing.md +2 -2
  293. data/docs/TrainingListing.md +16 -0
  294. data/docs/TranscriptionSettings.md +1 -0
  295. data/docs/TrunkBaseEntityListing.md +2 -2
  296. data/docs/TrunkEntityListing.md +2 -2
  297. data/docs/TrunkMetabaseEntityListing.md +2 -2
  298. data/docs/TrustEntityListing.md +2 -2
  299. data/docs/TrustUserEntityListing.md +2 -2
  300. data/docs/TrustorEntityListing.md +2 -2
  301. data/docs/TtsEngineEntityListing.md +2 -2
  302. data/docs/TtsVoiceEntityListing.md +2 -2
  303. data/docs/TwitterIntegrationEntityListing.md +2 -2
  304. data/docs/UpdateBusinessUnitRequest.md +15 -0
  305. data/docs/UpdateBusinessUnitSettings.md +16 -0
  306. data/docs/UpdatePlanningGroupRequest.md +16 -0
  307. data/docs/UpdateServiceGoalTemplate.md +17 -0
  308. data/docs/UserActionCategoryEntityListing.md +2 -2
  309. data/docs/UserAppEntityListing.md +2 -2
  310. data/docs/UserEntityListing.md +2 -2
  311. data/docs/UserLanguageEntityListing.md +2 -2
  312. data/docs/UserProfileEntityListing.md +2 -2
  313. data/docs/UserQueueEntityListing.md +2 -2
  314. data/docs/UserRecordingEntityListing.md +2 -2
  315. data/docs/UserScheduleAdherenceListing.md +14 -0
  316. data/docs/UserSkillEntityListing.md +2 -2
  317. data/docs/UsersApi.md +0 -72
  318. data/docs/ValueWrapperDate.md +13 -0
  319. data/docs/ValueWrapperString.md +13 -0
  320. data/docs/VoicemailMessageEntityListing.md +2 -2
  321. data/docs/WebChatMemberInfoEntityList.md +2 -2
  322. data/docs/WeekShiftTradeListResponse.md +13 -0
  323. data/docs/WeekShiftTradeResponse.md +14 -0
  324. data/docs/WfmIntradayPlanningGroupListing.md +14 -0
  325. data/docs/WhatsAppIntegrationEntityListing.md +2 -2
  326. data/docs/WorkforceManagementApi.md +4984 -806
  327. data/docs/WorkspaceEntityListing.md +2 -2
  328. data/docs/WorkspaceMemberEntityListing.md +2 -2
  329. data/docs/WrapupCodeEntityListing.md +2 -2
  330. data/lib/purecloudplatformclientv2.rb +140 -2
  331. data/lib/purecloudplatformclientv2/api/architect_api.rb +18 -0
  332. data/lib/purecloudplatformclientv2/api/authorization_api.rb +0 -85
  333. data/lib/purecloudplatformclientv2/api/external_contacts_api.rb +3 -3
  334. data/lib/purecloudplatformclientv2/api/knowledge_api.rb +1908 -0
  335. data/lib/purecloudplatformclientv2/api/recording_api.rb +22 -4
  336. data/lib/purecloudplatformclientv2/api/routing_api.rb +148 -0
  337. data/lib/purecloudplatformclientv2/api/search_api.rb +73 -0
  338. data/lib/purecloudplatformclientv2/api/users_api.rb +0 -85
  339. data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +6091 -1444
  340. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  341. data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +23 -23
  342. data/lib/purecloudplatformclientv2/models/add_shift_trade_request.rb +317 -0
  343. data/lib/purecloudplatformclientv2/models/additional_message.rb +30 -4
  344. data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +23 -23
  345. data/lib/purecloudplatformclientv2/models/analytics_conversation_async_query_response.rb +27 -1
  346. data/lib/purecloudplatformclientv2/models/analytics_user_details_async_query_response.rb +30 -4
  347. data/lib/purecloudplatformclientv2/models/array_node.rb +23 -23
  348. data/lib/purecloudplatformclientv2/models/async_forecast_operation_result.rb +294 -0
  349. data/lib/purecloudplatformclientv2/models/async_intraday_response.rb +268 -0
  350. data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +23 -23
  351. data/lib/purecloudplatformclientv2/models/authz_division_entity_listing.rb +23 -23
  352. data/lib/purecloudplatformclientv2/models/bu_abandon_rate.rb +234 -0
  353. data/lib/purecloudplatformclientv2/models/bu_agent_schedule_query_response.rb +310 -0
  354. data/lib/purecloudplatformclientv2/models/bu_agent_schedule_reschedule_response.rb +284 -0
  355. data/lib/purecloudplatformclientv2/models/bu_agent_schedule_update.rb +244 -0
  356. data/lib/purecloudplatformclientv2/models/bu_agent_schedules_query_response.rb +204 -0
  357. data/lib/purecloudplatformclientv2/models/bu_async_agent_schedules_query_response.rb +320 -0
  358. data/lib/purecloudplatformclientv2/models/bu_async_schedule_response.rb +268 -0
  359. data/lib/purecloudplatformclientv2/models/bu_async_schedule_run_response.rb +268 -0
  360. data/lib/purecloudplatformclientv2/models/bu_average_speed_of_answer.rb +234 -0
  361. data/lib/purecloudplatformclientv2/models/bu_copy_schedule_request.rb +238 -0
  362. data/lib/purecloudplatformclientv2/models/bu_create_blank_schedule_request.rb +264 -0
  363. data/lib/purecloudplatformclientv2/models/bu_current_agent_schedule_search_response.rb +338 -0
  364. data/lib/purecloudplatformclientv2/models/bu_forecast_generation_planning_group_result.rb +230 -0
  365. data/lib/purecloudplatformclientv2/models/bu_forecast_generation_result.rb +204 -0
  366. data/lib/purecloudplatformclientv2/models/bu_forecast_modification.rb +528 -0
  367. data/lib/purecloudplatformclientv2/models/bu_forecast_result.rb +282 -0
  368. data/lib/purecloudplatformclientv2/models/bu_forecast_result_response.rb +228 -0
  369. data/lib/purecloudplatformclientv2/models/bu_forecast_time_series_result.rb +256 -0
  370. data/lib/purecloudplatformclientv2/models/bu_generate_schedule_request.rb +269 -0
  371. data/lib/purecloudplatformclientv2/models/bu_get_current_agent_schedule_request.rb +238 -0
  372. data/lib/purecloudplatformclientv2/models/bu_headcount_forecast.rb +229 -0
  373. data/lib/purecloudplatformclientv2/models/bu_headcount_forecast_response.rb +228 -0
  374. data/lib/purecloudplatformclientv2/models/bu_intraday_data_group.rb +378 -0
  375. data/lib/purecloudplatformclientv2/models/bu_intraday_forecast_data.rb +228 -0
  376. data/lib/purecloudplatformclientv2/models/bu_intraday_response.rb +402 -0
  377. data/lib/purecloudplatformclientv2/models/bu_intraday_schedule_data.rb +202 -0
  378. data/lib/purecloudplatformclientv2/models/bu_management_unit_schedule_summary.rb +308 -0
  379. data/lib/purecloudplatformclientv2/models/bu_planning_group_headcount_forecast.rb +258 -0
  380. data/lib/purecloudplatformclientv2/models/bu_query_agent_schedules_request.rb +235 -0
  381. data/lib/purecloudplatformclientv2/models/bu_reschedule_agent_schedule_result.rb +254 -0
  382. data/lib/purecloudplatformclientv2/models/bu_reschedule_request.rb +451 -0
  383. data/lib/purecloudplatformclientv2/models/bu_reschedule_result.rb +308 -0
  384. data/lib/purecloudplatformclientv2/models/bu_schedule_list_item.rb +410 -0
  385. data/lib/purecloudplatformclientv2/models/bu_schedule_listing.rb +203 -0
  386. data/lib/purecloudplatformclientv2/models/bu_schedule_metadata.rb +438 -0
  387. data/lib/purecloudplatformclientv2/models/bu_schedule_reference_for_mu_route.rb +280 -0
  388. data/lib/purecloudplatformclientv2/models/bu_schedule_run.rb +632 -0
  389. data/lib/purecloudplatformclientv2/models/bu_schedule_run_listing.rb +203 -0
  390. data/lib/purecloudplatformclientv2/models/bu_service_level.rb +260 -0
  391. data/lib/purecloudplatformclientv2/models/bu_short_term_forecast.rb +584 -0
  392. data/lib/purecloudplatformclientv2/models/bu_short_term_forecast_list_item.rb +398 -0
  393. data/lib/purecloudplatformclientv2/models/bu_short_term_forecast_listing.rb +203 -0
  394. data/lib/purecloudplatformclientv2/models/bu_short_term_forecast_reference.rb +286 -0
  395. data/lib/purecloudplatformclientv2/models/bu_short_term_forecasting_settings.rb +202 -0
  396. data/lib/purecloudplatformclientv2/models/bulk_shift_trade_state_update_request.rb +209 -0
  397. data/lib/purecloudplatformclientv2/models/bulk_update_shift_trade_state_request_item.rb +278 -0
  398. data/lib/purecloudplatformclientv2/models/bulk_update_shift_trade_state_response.rb +268 -0
  399. data/lib/purecloudplatformclientv2/models/bulk_update_shift_trade_state_result.rb +203 -0
  400. data/lib/purecloudplatformclientv2/models/bulk_update_shift_trade_state_result_item.rb +360 -0
  401. data/lib/purecloudplatformclientv2/models/business_unit.rb +305 -0
  402. data/lib/purecloudplatformclientv2/models/business_unit_activity_code.rb +476 -0
  403. data/lib/purecloudplatformclientv2/models/business_unit_activity_code_listing.rb +204 -0
  404. data/lib/purecloudplatformclientv2/models/business_unit_list_item.rb +305 -0
  405. data/lib/purecloudplatformclientv2/models/business_unit_listing.rb +203 -0
  406. data/lib/purecloudplatformclientv2/models/business_unit_settings.rb +309 -0
  407. data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +23 -23
  408. data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +23 -23
  409. data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +23 -23
  410. data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +23 -23
  411. data/lib/purecloudplatformclientv2/models/callback.rb +27 -1
  412. data/lib/purecloudplatformclientv2/models/callback_basic.rb +27 -1
  413. data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +23 -23
  414. data/lib/purecloudplatformclientv2/models/callback_media_participant.rb +28 -2
  415. data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +23 -23
  416. data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +23 -23
  417. data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +23 -23
  418. data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +23 -23
  419. data/lib/purecloudplatformclientv2/models/category_listing.rb +278 -0
  420. data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +23 -23
  421. data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +23 -23
  422. data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +23 -23
  423. data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +23 -23
  424. data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +23 -23
  425. data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +23 -23
  426. data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +23 -23
  427. data/lib/purecloudplatformclientv2/models/contact_list_division_view_listing.rb +23 -23
  428. data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +23 -23
  429. data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +23 -23
  430. data/lib/purecloudplatformclientv2/models/contact_listing.rb +23 -23
  431. data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +23 -23
  432. data/lib/purecloudplatformclientv2/models/copy_bu_forecast_request.rb +238 -0
  433. data/lib/purecloudplatformclientv2/models/create_business_unit_request.rb +269 -0
  434. data/lib/purecloudplatformclientv2/models/create_business_unit_settings.rb +278 -0
  435. data/lib/purecloudplatformclientv2/models/create_planning_group_request.rb +271 -0
  436. data/lib/purecloudplatformclientv2/models/create_service_goal_template.rb +285 -0
  437. data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +23 -23
  438. data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +23 -23
  439. data/lib/purecloudplatformclientv2/models/cursors.rb +226 -0
  440. data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +23 -23
  441. data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +23 -23
  442. data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +23 -23
  443. data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +23 -23
  444. data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +23 -23
  445. data/lib/purecloudplatformclientv2/models/dialogflow_agent_summary_entity_listing.rb +23 -23
  446. data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +23 -23
  447. data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +23 -23
  448. data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +23 -23
  449. data/lib/purecloudplatformclientv2/models/divs_permitted_entity_listing.rb +23 -23
  450. data/lib/purecloudplatformclientv2/models/dnc_list_division_view_listing.rb +23 -23
  451. data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +23 -23
  452. data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +23 -23
  453. data/lib/purecloudplatformclientv2/models/document_category_input.rb +207 -0
  454. data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +23 -23
  455. data/lib/purecloudplatformclientv2/models/document_faq.rb +266 -0
  456. data/lib/purecloudplatformclientv2/models/document_listing.rb +278 -0
  457. data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +23 -23
  458. data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +23 -23
  459. data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +23 -23
  460. data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +23 -23
  461. data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +23 -23
  462. data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +23 -23
  463. data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +23 -23
  464. data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +23 -23
  465. data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +23 -23
  466. data/lib/purecloudplatformclientv2/models/email_message_listing.rb +23 -23
  467. data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +23 -23
  468. data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +23 -23
  469. data/lib/purecloudplatformclientv2/models/entity_listing.rb +104 -4
  470. data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +23 -23
  471. data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +23 -23
  472. data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +23 -23
  473. data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +23 -23
  474. data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +23 -23
  475. data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +23 -23
  476. data/lib/purecloudplatformclientv2/models/external_organization_trustor_link.rb +306 -0
  477. data/lib/purecloudplatformclientv2/models/facebook_integration_entity_listing.rb +23 -23
  478. data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +23 -23
  479. data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +23 -23
  480. data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +23 -23
  481. data/lib/purecloudplatformclientv2/models/flow_outcome_listing.rb +23 -23
  482. data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +23 -23
  483. data/lib/purecloudplatformclientv2/models/forecast_abandon_rate_response.rb +202 -0
  484. data/lib/purecloudplatformclientv2/models/forecast_average_speed_of_answer_response.rb +202 -0
  485. data/lib/purecloudplatformclientv2/models/forecast_planning_group_data.rb +258 -0
  486. data/lib/purecloudplatformclientv2/models/forecast_planning_group_response.rb +282 -0
  487. data/lib/purecloudplatformclientv2/models/forecast_planning_groups_response.rb +203 -0
  488. data/lib/purecloudplatformclientv2/models/forecast_service_goal_template_response.rb +254 -0
  489. data/lib/purecloudplatformclientv2/models/forecast_service_level_response.rb +228 -0
  490. data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +23 -23
  491. data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +23 -23
  492. data/lib/purecloudplatformclientv2/models/generate_bu_forecast_request.rb +233 -0
  493. data/lib/purecloudplatformclientv2/models/greeting_listing.rb +23 -23
  494. data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +23 -23
  495. data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +23 -23
  496. data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +23 -23
  497. data/lib/purecloudplatformclientv2/models/inbound_domain_patch_request.rb +228 -0
  498. data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +23 -23
  499. data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +23 -23
  500. data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +23 -23
  501. data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +23 -23
  502. data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +23 -23
  503. data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +23 -23
  504. data/lib/purecloudplatformclientv2/models/intraday_performance_prediction_data.rb +254 -0
  505. data/lib/purecloudplatformclientv2/models/intraday_planning_group_request.rb +294 -0
  506. data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +23 -23
  507. data/lib/purecloudplatformclientv2/models/json_node.rb +23 -23
  508. data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +23 -23
  509. data/lib/purecloudplatformclientv2/models/knowledge_base.rb +376 -0
  510. data/lib/purecloudplatformclientv2/models/knowledge_base_listing.rb +278 -0
  511. data/lib/purecloudplatformclientv2/models/knowledge_category.rb +403 -0
  512. data/lib/purecloudplatformclientv2/models/knowledge_category_request.rb +311 -0
  513. data/lib/purecloudplatformclientv2/models/knowledge_document.rb +501 -0
  514. data/lib/purecloudplatformclientv2/models/knowledge_document_bulk_request.rb +327 -0
  515. data/lib/purecloudplatformclientv2/models/knowledge_document_request.rb +301 -0
  516. data/lib/purecloudplatformclientv2/models/knowledge_extended_category.rb +457 -0
  517. data/lib/purecloudplatformclientv2/models/knowledge_search_document.rb +527 -0
  518. data/lib/purecloudplatformclientv2/models/knowledge_search_request.rb +371 -0
  519. data/lib/purecloudplatformclientv2/models/knowledge_search_response.rb +334 -0
  520. data/lib/purecloudplatformclientv2/models/knowledge_training.rb +489 -0
  521. data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +23 -23
  522. data/lib/purecloudplatformclientv2/models/lex_bot_alias_entity_listing.rb +23 -23
  523. data/lib/purecloudplatformclientv2/models/lex_bot_entity_listing.rb +23 -23
  524. data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +23 -23
  525. data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +23 -23
  526. data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +23 -23
  527. data/lib/purecloudplatformclientv2/models/line_integration_entity_listing.rb +23 -23
  528. data/lib/purecloudplatformclientv2/models/list_wrapper_interval.rb +203 -0
  529. data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +23 -23
  530. data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +23 -23
  531. data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +23 -23
  532. data/lib/purecloudplatformclientv2/models/match_shift_trade_request.rb +264 -0
  533. data/lib/purecloudplatformclientv2/models/match_shift_trade_response.rb +258 -0
  534. data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +23 -23
  535. data/lib/purecloudplatformclientv2/models/messaging_integration_entity_listing.rb +23 -23
  536. data/lib/purecloudplatformclientv2/models/messaging_sticker_entity_listing.rb +23 -23
  537. data/lib/purecloudplatformclientv2/models/messaging_template_request.rb +230 -0
  538. data/lib/purecloudplatformclientv2/models/metabase.rb +2 -2
  539. data/lib/purecloudplatformclientv2/models/mu_reschedule_result_wrapper.rb +204 -0
  540. data/lib/purecloudplatformclientv2/models/note_listing.rb +23 -23
  541. data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +23 -23
  542. data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +23 -23
  543. data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +23 -23
  544. data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +23 -23
  545. data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +23 -23
  546. data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +23 -23
  547. data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +23 -23
  548. data/lib/purecloudplatformclientv2/models/patch_bu_rescheduling_options_management_unit_request.rb +233 -0
  549. data/lib/purecloudplatformclientv2/models/patch_bu_rescheduling_options_request.rb +204 -0
  550. data/lib/purecloudplatformclientv2/models/patch_bu_schedule_run_request.rb +202 -0
  551. data/lib/purecloudplatformclientv2/models/patch_shift_trade_request.rb +285 -0
  552. data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +23 -23
  553. data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +23 -23
  554. data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +23 -23
  555. data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +23 -23
  556. data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +23 -23
  557. data/lib/purecloudplatformclientv2/models/planning_group.rb +334 -0
  558. data/lib/purecloudplatformclientv2/models/planning_group_list.rb +204 -0
  559. data/lib/purecloudplatformclientv2/models/planning_group_reference.rb +229 -0
  560. data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +23 -23
  561. data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +23 -23
  562. data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +23 -23
  563. data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +23 -23
  564. data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +23 -23
  565. data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +23 -23
  566. data/lib/purecloudplatformclientv2/models/recipient_listing.rb +23 -23
  567. data/lib/purecloudplatformclientv2/models/recording_job_entity_listing.rb +23 -23
  568. data/lib/purecloudplatformclientv2/models/relationship_listing.rb +23 -23
  569. data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +23 -23
  570. data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +23 -23
  571. data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +23 -23
  572. data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +23 -23
  573. data/lib/purecloudplatformclientv2/models/reporting_export_metadata_job_listing.rb +23 -23
  574. data/lib/purecloudplatformclientv2/models/rescheduling_management_unit_response.rb +228 -0
  575. data/lib/purecloudplatformclientv2/models/rescheduling_options_run_response.rb +440 -0
  576. data/lib/purecloudplatformclientv2/models/response_entity_list.rb +23 -23
  577. data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +23 -23
  578. data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +23 -23
  579. data/lib/purecloudplatformclientv2/models/route_path_request.rb +333 -0
  580. data/lib/purecloudplatformclientv2/models/route_path_response.rb +297 -0
  581. data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +23 -23
  582. data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +23 -23
  583. data/lib/purecloudplatformclientv2/models/schedule_generation_message.rb +244 -0
  584. data/lib/purecloudplatformclientv2/models/schedule_generation_result.rb +282 -0
  585. data/lib/purecloudplatformclientv2/models/schedule_generation_result_summary.rb +254 -0
  586. data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +23 -23
  587. data/lib/purecloudplatformclientv2/models/scheduler_message_argument.rb +242 -0
  588. data/lib/purecloudplatformclientv2/models/scheduling_testing_options_request.rb +280 -0
  589. data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +23 -23
  590. data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +23 -23
  591. data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +23 -23
  592. data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +23 -23
  593. data/lib/purecloudplatformclientv2/models/search_shift_trade_response.rb +256 -0
  594. data/lib/purecloudplatformclientv2/models/search_shift_trades_request.rb +235 -0
  595. data/lib/purecloudplatformclientv2/models/search_shift_trades_response.rb +204 -0
  596. data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +23 -23
  597. data/lib/purecloudplatformclientv2/models/service_goal_template.rb +358 -0
  598. data/lib/purecloudplatformclientv2/models/service_goal_template_list.rb +204 -0
  599. data/lib/purecloudplatformclientv2/models/service_goal_template_reference.rb +228 -0
  600. data/lib/purecloudplatformclientv2/models/set_wrapper_route_path_request.rb +203 -0
  601. data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +23 -23
  602. data/lib/purecloudplatformclientv2/models/shift_trade_activity_preview_response.rb +280 -0
  603. data/lib/purecloudplatformclientv2/models/shift_trade_match_review_response.rb +284 -0
  604. data/lib/purecloudplatformclientv2/models/shift_trade_match_review_user_response.rb +306 -0
  605. data/lib/purecloudplatformclientv2/models/shift_trade_match_violation.rb +244 -0
  606. data/lib/purecloudplatformclientv2/models/shift_trade_preview_response.rb +204 -0
  607. data/lib/purecloudplatformclientv2/models/shift_trade_response.rb +2 -2
  608. data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +23 -23
  609. data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +23 -23
  610. data/lib/purecloudplatformclientv2/models/sms_address_entity_listing.rb +23 -23
  611. data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +23 -23
  612. data/lib/purecloudplatformclientv2/models/source_planning_group_request.rb +239 -0
  613. data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +23 -23
  614. data/lib/purecloudplatformclientv2/models/subject_division_grants_entity_listing.rb +23 -23
  615. data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +23 -23
  616. data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +23 -23
  617. data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +23 -23
  618. data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +23 -23
  619. data/lib/purecloudplatformclientv2/models/template_parameter.rb +228 -0
  620. data/lib/purecloudplatformclientv2/models/test_message.rb +375 -0
  621. data/lib/purecloudplatformclientv2/models/text_message_listing.rb +23 -23
  622. data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +23 -23
  623. data/lib/purecloudplatformclientv2/models/training_listing.rb +278 -0
  624. data/lib/purecloudplatformclientv2/models/transcription_settings.rb +30 -4
  625. data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +23 -23
  626. data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +23 -23
  627. data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +23 -23
  628. data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +23 -23
  629. data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +23 -23
  630. data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +23 -23
  631. data/lib/purecloudplatformclientv2/models/tts_engine_entity_listing.rb +23 -23
  632. data/lib/purecloudplatformclientv2/models/tts_voice_entity_listing.rb +23 -23
  633. data/lib/purecloudplatformclientv2/models/twitter_integration_entity_listing.rb +23 -23
  634. data/lib/purecloudplatformclientv2/models/{transcript_property.rb → update_business_unit_request.rb} +23 -23
  635. data/lib/purecloudplatformclientv2/models/update_business_unit_settings.rb +299 -0
  636. data/lib/purecloudplatformclientv2/models/update_planning_group_request.rb +285 -0
  637. data/lib/purecloudplatformclientv2/models/update_service_goal_template.rb +311 -0
  638. data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +23 -23
  639. data/lib/purecloudplatformclientv2/models/user_app_entity_listing.rb +23 -23
  640. data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +23 -23
  641. data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +23 -23
  642. data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +23 -23
  643. data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +23 -23
  644. data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +23 -23
  645. data/lib/purecloudplatformclientv2/models/user_schedule_adherence_listing.rb +229 -0
  646. data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +23 -23
  647. data/lib/purecloudplatformclientv2/models/value_wrapper_date.rb +203 -0
  648. data/lib/purecloudplatformclientv2/models/value_wrapper_string.rb +203 -0
  649. data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +23 -23
  650. data/lib/purecloudplatformclientv2/models/web_chat_member_info_entity_list.rb +23 -23
  651. data/lib/purecloudplatformclientv2/models/week_shift_trade_list_response.rb +203 -0
  652. data/lib/purecloudplatformclientv2/models/week_shift_trade_response.rb +228 -0
  653. data/lib/purecloudplatformclientv2/models/wfm_intraday_planning_group_listing.rb +244 -0
  654. data/lib/purecloudplatformclientv2/models/whats_app_integration_entity_listing.rb +23 -23
  655. data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +23 -23
  656. data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +23 -23
  657. data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +23 -23
  658. data/lib/purecloudplatformclientv2/version.rb +1 -1
  659. metadata +282 -6
  660. data/docs/SpeechTextAnalyticsApi.md +0 -80
  661. data/docs/TranscriptProperty.md +0 -15
  662. data/lib/purecloudplatformclientv2/api/speech_text_analytics_api.rb +0 -102
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: BuAverageSpeedOfAnswer
3
+ ---
4
+ ## PureCloud::BuAverageSpeedOfAnswer
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **include** | **BOOLEAN** | Whether to include average speed of answer (ASA) in the associated configuration | |
11
+ | **seconds** | **Integer** | The target average speed of answer (ASA) in seconds. Required if include == true | [optional] |
12
+ {: class="table table-striped"}
13
+
14
+
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: BuCopyScheduleRequest
3
+ ---
4
+ ## PureCloud::BuCopyScheduleRequest
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **description** | **String** | The description for the new schedule | |
11
+ | **week_date** | **Date** | The start weekDate for the new copy of the schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd | |
12
+ {: class="table table-striped"}
13
+
14
+
@@ -0,0 +1,15 @@
1
+ ---
2
+ title: BuCreateBlankScheduleRequest
3
+ ---
4
+ ## PureCloud::BuCreateBlankScheduleRequest
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **description** | **String** | The description for the schedule | |
11
+ | **short_term_forecast** | [**BuShortTermForecastReference**](BuShortTermForecastReference.html) | The forecast to use when generating the schedule. Note that the forecast must fully encompass the schedule's start week + week count | [optional] |
12
+ | **week_count** | **Integer** | The number of weeks in the schedule. One extra day is added at the end | |
13
+ {: class="table table-striped"}
14
+
15
+
@@ -0,0 +1,18 @@
1
+ ---
2
+ title: BuCurrentAgentScheduleSearchResponse
3
+ ---
4
+ ## PureCloud::BuCurrentAgentScheduleSearchResponse
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **agent_schedules** | [**Array<BuAgentScheduleSearchResponse>**](BuAgentScheduleSearchResponse.html) | The requested agent schedules | [optional] |
11
+ | **business_unit_time_zone** | **String** | The time zone configured for the business unit to which this schedule applies | [optional] |
12
+ | **published_schedules** | [**Array<BuAgentSchedulePublishedScheduleReference>**](BuAgentSchedulePublishedScheduleReference.html) | References to all published week schedules overlapping the start/end date query parameters | [optional] |
13
+ | **start_date** | **DateTime** | The start date of the schedules. Only populated on notifications. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
14
+ | **end_date** | **DateTime** | The end date of the schedules. Only populated on notifications. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
15
+ | **updates** | [**Array<BuAgentScheduleUpdate>**](BuAgentScheduleUpdate.html) | The list of updates for the schedule. Only used in notifications | [optional] |
16
+ {: class="table table-striped"}
17
+
18
+
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: BuForecastGenerationPlanningGroupResult
3
+ ---
4
+ ## PureCloud::BuForecastGenerationPlanningGroupResult
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **planning_group_id** | **String** | The ID of the planning group | [optional] |
11
+ | **metric_results** | [**Array<BuForecastTimeSeriesResult>**](BuForecastTimeSeriesResult.html) | The generation results for the associated planning group | [optional] |
12
+ {: class="table table-striped"}
13
+
14
+
@@ -0,0 +1,13 @@
1
+ ---
2
+ title: BuForecastGenerationResult
3
+ ---
4
+ ## PureCloud::BuForecastGenerationResult
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **planning_group_results** | [**Array<BuForecastGenerationPlanningGroupResult>**](BuForecastGenerationPlanningGroupResult.html) | Generation results, broken down by planning group | [optional] |
11
+ {: class="table table-striped"}
12
+
13
+
@@ -0,0 +1,23 @@
1
+ ---
2
+ title: BuForecastModification
3
+ ---
4
+ ## PureCloud::BuForecastModification
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **type** | **String** | The type of the modification | |
11
+ | **start_interval_index** | **Integer** | The number of 15 minute intervals past referenceStartDate representing the first interval to which to apply this modification. Must be null if values is populated | [optional] |
12
+ | **end_interval_index** | **Integer** | The number of 15 minute intervals past referenceStartDate representing the last interval to which to apply this modification. Must be null if values is populated | [optional] |
13
+ | **metric** | **String** | The metric to which this modification applies | |
14
+ | **legacy_metric** | **String** | The legacy metric to which this modification applies if applicable | [optional] |
15
+ | **value** | **Float** | The value of the modification. Must be null if \"values\" is populated | [optional] |
16
+ | **values** | [**Array<WfmForecastModificationIntervalOffsetValue>**](WfmForecastModificationIntervalOffsetValue.html) | The list of values to update. Only applicable for grid-type modifications. Must be null if \"value\" is populated | [optional] |
17
+ | **display_granularity** | **String** | The client side display granularity of the modification, expressed in the ISO-8601 duration format. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H | |
18
+ | **granularity** | **String** | The actual granularity of the modification as stored behind the scenes, expressed in the ISO-8601 duration format. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H | [optional] |
19
+ | **enabled** | **BOOLEAN** | Whether the modification is enabled for the forecast | |
20
+ | **planning_group_ids** | **Array<String>** | The IDs of the planning groups to which this forecast modification applies. Leave empty to apply to all | [optional] |
21
+ {: class="table table-striped"}
22
+
23
+
@@ -0,0 +1,16 @@
1
+ ---
2
+ title: BuForecastResult
3
+ ---
4
+ ## PureCloud::BuForecastResult
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **reference_start_date** | **DateTime** | The reference start date for interval-based data for this forecast. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
11
+ | **planning_groups** | [**Array<ForecastPlanningGroupData>**](ForecastPlanningGroupData.html) | The forecast data broken up by planning group | [optional] |
12
+ | **week_number** | **Integer** | The week number represented by this response | [optional] |
13
+ | **week_count** | **Integer** | The number of weeks in this forecast | [optional] |
14
+ {: class="table table-striped"}
15
+
16
+
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: BuForecastResultResponse
3
+ ---
4
+ ## PureCloud::BuForecastResultResponse
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **result** | [**BuForecastResult**](BuForecastResult.html) | The result of the operation. Populated whenever the result is small enough to pass through the api directly | [optional] |
11
+ | **download_url** | **String** | The download url to fetch the result. Only populated if the result is too large to pass through the api directly | [optional] |
12
+ {: class="table table-striped"}
13
+
14
+
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: BuForecastTimeSeriesResult
3
+ ---
4
+ ## PureCloud::BuForecastTimeSeriesResult
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **metric** | **String** | The metric this result applies to | [optional] |
11
+ | **forecasting_method** | **String** | The forecasting method that was used for this metric | [optional] |
12
+ {: class="table table-striped"}
13
+
14
+
@@ -0,0 +1,15 @@
1
+ ---
2
+ title: BuGenerateScheduleRequest
3
+ ---
4
+ ## PureCloud::BuGenerateScheduleRequest
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **description** | **String** | The description for the schedule | |
11
+ | **short_term_forecast** | [**BuShortTermForecastReference**](BuShortTermForecastReference.html) | The forecast to use when generating the schedule. Note that the forecast must fully encompass the schedule's start week + week count | |
12
+ | **week_count** | **Integer** | The number of weeks in the schedule. One extra day is added at the end | |
13
+ {: class="table table-striped"}
14
+
15
+
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: BuGetCurrentAgentScheduleRequest
3
+ ---
4
+ ## PureCloud::BuGetCurrentAgentScheduleRequest
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **start_date** | **DateTime** | Start date of the range to search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | |
11
+ | **end_date** | **DateTime** | End date of the range to search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | |
12
+ {: class="table table-striped"}
13
+
14
+
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: BuHeadcountForecast
3
+ ---
4
+ ## PureCloud::BuHeadcountForecast
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **entities** | [**Array<BuPlanningGroupHeadcountForecast>**](BuPlanningGroupHeadcountForecast.html) | | [optional] |
11
+ | **reference_start_date** | **DateTime** | Reference start date for the interval values in each forecast entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
12
+ {: class="table table-striped"}
13
+
14
+
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: BuHeadcountForecastResponse
3
+ ---
4
+ ## PureCloud::BuHeadcountForecastResponse
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **result** | [**BuHeadcountForecast**](BuHeadcountForecast.html) | The headcount forecast, null when downloadUrl is provided | [optional] |
11
+ | **download_url** | **String** | Download URL. Null unless the response is too large to pass directly through the api | [optional] |
12
+ {: class="table table-striped"}
13
+
14
+
@@ -0,0 +1,19 @@
1
+ ---
2
+ title: BuIntradayDataGroup
3
+ ---
4
+ ## PureCloud::BuIntradayDataGroup
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **media_type** | **String** | The media type associated with this intraday group | [optional] |
11
+ | **forecast_data_summary** | [**BuIntradayForecastData**](BuIntradayForecastData.html) | Forecast data summary for this date range | [optional] |
12
+ | **forecast_data_per_interval** | [**Array<BuIntradayForecastData>**](BuIntradayForecastData.html) | Forecast data per interval for this date range | [optional] |
13
+ | **schedule_data_summary** | [**BuIntradayScheduleData**](BuIntradayScheduleData.html) | Schedule data summary for this date range | [optional] |
14
+ | **schedule_data_per_interval** | [**Array<BuIntradayScheduleData>**](BuIntradayScheduleData.html) | Schedule data per interval for this date range | [optional] |
15
+ | **performance_prediction_data_summary** | [**IntradayPerformancePredictionData**](IntradayPerformancePredictionData.html) | Performance prediction data summary for this date range | [optional] |
16
+ | **performance_prediction_data_per_interval** | [**Array<IntradayPerformancePredictionData>**](IntradayPerformancePredictionData.html) | Performance prediction data per interval for this date range | [optional] |
17
+ {: class="table table-striped"}
18
+
19
+
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: BuIntradayForecastData
3
+ ---
4
+ ## PureCloud::BuIntradayForecastData
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **offered** | **Float** | The number of interactions routed into the queues in the selected planning groups for the given media type for an agent to answer | [optional] |
11
+ | **average_handle_time_seconds** | **Float** | The average handle time in seconds an agent spent handling interactions | [optional] |
12
+ {: class="table table-striped"}
13
+
14
+
@@ -0,0 +1,20 @@
1
+ ---
2
+ title: BuIntradayResponse
3
+ ---
4
+ ## PureCloud::BuIntradayResponse
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **start_date** | **DateTime** | The start of the date range for which this data applies. This is also the start reference point for the intervals represented in the various arrays. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
11
+ | **end_date** | **DateTime** | The end of the date range for which this data applies. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
12
+ | **interval_length_minutes** | **Integer** | The aggregation period in minutes, which determines the interval duration of the returned data | [optional] |
13
+ | **no_data_reason** | **String** | If not null, the reason there was no data for the request | [optional] |
14
+ | **categories** | **Array<String>** | The categories to which this data corresponds | [optional] |
15
+ | **short_term_forecast** | [**BuShortTermForecastReference**](BuShortTermForecastReference.html) | Short term forecast reference | [optional] |
16
+ | **schedule** | [**BuScheduleReference**](BuScheduleReference.html) | Schedule reference | [optional] |
17
+ | **intraday_data_groupings** | [**Array<BuIntradayDataGroup>**](BuIntradayDataGroup.html) | Intraday data grouped by a single media type and set of planning group IDs | [optional] |
18
+ {: class="table table-striped"}
19
+
20
+
@@ -0,0 +1,13 @@
1
+ ---
2
+ title: BuIntradayScheduleData
3
+ ---
4
+ ## PureCloud::BuIntradayScheduleData
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **on_queue_time_seconds** | **Integer** | The total on-queue time in seconds for all agents in this group | [optional] |
11
+ {: class="table table-striped"}
12
+
13
+
@@ -0,0 +1,17 @@
1
+ ---
2
+ title: BuManagementUnitScheduleSummary
3
+ ---
4
+ ## PureCloud::BuManagementUnitScheduleSummary
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **management_unit** | [**ManagementUnitReference**](ManagementUnitReference.html) | The management unit to which this summary applies | [optional] |
11
+ | **agent_count** | **Integer** | The number of agents from this management unit that are in the schedule | [optional] |
12
+ | **start_date** | **DateTime** | The start of the schedule change in the management unit. Only populated in schedule update notifications. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
13
+ | **end_date** | **DateTime** | The end of the schedule change in the management unit. Only populated in schedule update notifications. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
14
+ | **agents** | [**Array<UserReference>**](UserReference.html) | The changed agents in the management unit. Only populated in schedule update notifications | [optional] |
15
+ {: class="table table-striped"}
16
+
17
+
@@ -0,0 +1,15 @@
1
+ ---
2
+ title: BuPlanningGroupHeadcountForecast
3
+ ---
4
+ ## PureCloud::BuPlanningGroupHeadcountForecast
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **planning_group** | [**PlanningGroupReference**](PlanningGroupReference.html) | The planning group to which this portion of the headcount forecast applies | [optional] |
11
+ | **required_per_interval** | **Array<Float>** | Required headcount per interval, referenced against the reference start date | [optional] |
12
+ | **required_without_shrinkage_per_interval** | **Array<Float>** | Required headcount per interval without accounting for shrinkage, referenced against the reference start date | [optional] |
13
+ {: class="table table-striped"}
14
+
15
+
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: BuQueryAgentSchedulesRequest
3
+ ---
4
+ ## PureCloud::BuQueryAgentSchedulesRequest
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **management_unit_id** | **String** | The ID of the management unit to query | |
11
+ | **user_ids** | **Array<String>** | The IDs of the users to query. Omit to query all user schedules in the management unit | [optional] |
12
+ {: class="table table-striped"}
13
+
14
+
@@ -0,0 +1,15 @@
1
+ ---
2
+ title: BuRescheduleAgentScheduleResult
3
+ ---
4
+ ## PureCloud::BuRescheduleAgentScheduleResult
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **management_unit** | [**ManagementUnitReference**](ManagementUnitReference.html) | The management unit to which this part of the result applies | [optional] |
11
+ | **download_result** | [**MuRescheduleResultWrapper**](MuRescheduleResultWrapper.html) | The agent schedules. Result will always come via the downloadUrl; however the schema is included for documentation | [optional] |
12
+ | **download_url** | **String** | The download URL from which to fetch the result | [optional] |
13
+ {: class="table table-striped"}
14
+
15
+
@@ -0,0 +1,21 @@
1
+ ---
2
+ title: BuRescheduleRequest
3
+ ---
4
+ ## PureCloud::BuRescheduleRequest
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **start_date** | **DateTime** | The start of the range to reschedule. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | |
11
+ | **end_date** | **DateTime** | The end of the range to reschedule. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | |
12
+ | **agent_ids** | **Array<String>** | The IDs of the agents to consider for rescheduling. Omit to consider all agents in the specified management units.Agents not in the specified management units will be ignored | [optional] |
13
+ | **activity_code_ids** | **Array<String>** | The IDs of the activity codes to consider for rescheduling. Omit to consider all activity codes | [optional] |
14
+ | **management_unit_ids** | **Array<String>** | The IDs of the management units to reschedule | |
15
+ | **do_not_change_weekly_paid_time** | **BOOLEAN** | Instructs the scheduler whether it is allowed to change weekly paid time | |
16
+ | **do_not_change_daily_paid_time** | **BOOLEAN** | Instructs the scheduler whether it is allowed to change daily paid time | |
17
+ | **do_not_change_shift_start_times** | **BOOLEAN** | Instructs the scheduler whether it is allowed to change shift start times | |
18
+ | **do_not_change_manually_edited_shifts** | **BOOLEAN** | Instructs the scheduler whether it is allowed to change manually edited shifts | |
19
+ {: class="table table-striped"}
20
+
21
+
@@ -0,0 +1,17 @@
1
+ ---
2
+ title: BuRescheduleResult
3
+ ---
4
+ ## PureCloud::BuRescheduleResult
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **generation_results** | [**ScheduleGenerationResult**](ScheduleGenerationResult.html) | The generation results. Note the result will always be delivered via the downloadUrl; however the schema is included for documentation | [optional] |
11
+ | **generation_results_download_url** | **String** | The download URL from which to fetch the generation results for the rescheduling run | [optional] |
12
+ | **headcount_forecast** | [**BuHeadcountForecast**](BuHeadcountForecast.html) | The headcount forecast. Note the result will always be delivered via the downloadUrl; however the schema is included for documentation | [optional] |
13
+ | **headcount_forecast_download_url** | **String** | The download URL from which to fetch the headcount forecast for the rescheduling run | [optional] |
14
+ | **agent_schedules** | [**Array<BuRescheduleAgentScheduleResult>**](BuRescheduleAgentScheduleResult.html) | List of download links for agent schedules produced by the rescheduling run | [optional] |
15
+ {: class="table table-striped"}
16
+
17
+
@@ -0,0 +1,21 @@
1
+ ---
2
+ title: BuScheduleListItem
3
+ ---
4
+ ## PureCloud::BuScheduleListItem
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
+ | **week_date** | **Date** | The start week date for this schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd | [optional] |
12
+ | **week_count** | **Integer** | The number of weeks spanned by this schedule | [optional] |
13
+ | **description** | **String** | The description of this schedule | [optional] |
14
+ | **published** | **BOOLEAN** | Whether this schedule is published | [optional] |
15
+ | **short_term_forecast** | [**BuShortTermForecastReference**](BuShortTermForecastReference.html) | The forecast used for this schedule, if applicable | [optional] |
16
+ | **generation_results** | [**ScheduleGenerationResultSummary**](ScheduleGenerationResultSummary.html) | Generation result summary for this schedule, if applicable | [optional] |
17
+ | **metadata** | [**WfmVersionedEntityMetadata**](WfmVersionedEntityMetadata.html) | Version metadata for this schedule | [optional] |
18
+ | **self_uri** | **String** | The URI for this object | [optional] |
19
+ {: class="table table-striped"}
20
+
21
+
@@ -0,0 +1,13 @@
1
+ ---
2
+ title: BuScheduleListing
3
+ ---
4
+ ## PureCloud::BuScheduleListing
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **entities** | [**Array<BuScheduleListItem>**](BuScheduleListItem.html) | | [optional] |
11
+ {: class="table table-striped"}
12
+
13
+