purecloud 0.64.1 → 0.65.1

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 (585) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +3 -3
  3. data/bin/notificationMappings.json +68 -0
  4. data/config-ruby.json +1 -1
  5. data/doc_out/ADFS.html.md +1 -1
  6. data/doc_out/AgentActivityEntityListing.html.md +2 -2
  7. data/doc_out/AggregationQuery.html.md +1 -1
  8. data/doc_out/AnalyticsConversation.html.md +1 -0
  9. data/doc_out/AnalyticsConversationSegment.html.md +3 -3
  10. data/doc_out/AnalyticsSession.html.md +2 -2
  11. data/doc_out/AttemptLimitsEntityListing.html.md +2 -2
  12. data/doc_out/AttemptLimitsNotification.html.md +23 -0
  13. data/doc_out/AttemptLimitsNotificationRecallEntries.html.md +15 -0
  14. data/doc_out/AttemptLimitsNotificationRecallEntry.html.md +15 -0
  15. data/doc_out/AttributeEntityListing.html.md +2 -2
  16. data/doc_out/AuditMessage.html.md +1 -1
  17. data/doc_out/CalibrationEntityListing.html.md +2 -2
  18. data/doc_out/Call.html.md +4 -4
  19. data/doc_out/CallConversationEntityListing.html.md +2 -2
  20. data/doc_out/CallForwarding.html.md +1 -1
  21. data/doc_out/CallMediaParticipant.html.md +6 -6
  22. data/doc_out/CallableTimeSetEntityListing.html.md +2 -2
  23. data/doc_out/CallableTimeSetNotification.html.md +19 -0
  24. data/doc_out/CallableTimeSetNotificationCallableTime.html.md +15 -0
  25. data/doc_out/CallableTimeSetNotificationCallableTimes.html.md +15 -0
  26. data/doc_out/CallableTimeSetNotificationTimeSlot.html.md +16 -0
  27. data/doc_out/CallableTimeSetNotificationTimeSlots.html.md +16 -0
  28. data/doc_out/Callback.html.md +3 -2
  29. data/doc_out/CallbackConversationEntityListing.html.md +2 -2
  30. data/doc_out/CallbackConversationNotificationDialerPreview.html.md +1 -1
  31. data/doc_out/CallbackMediaParticipant.html.md +5 -4
  32. data/doc_out/Campaign.html.md +1 -1
  33. data/doc_out/CampaignEntityListing.html.md +2 -2
  34. data/doc_out/CampaignInteraction.html.md +1 -1
  35. data/doc_out/CampaignNotification.html.md +41 -0
  36. data/doc_out/CampaignNotificationContactSort.html.md +16 -0
  37. data/doc_out/CampaignNotificationError.html.md +15 -0
  38. data/doc_out/CampaignNotificationErrors.html.md +15 -0
  39. data/doc_out/{ConversationNotificationDialerPreviewPhoneNumberColumns.html.md → CampaignNotificationPhoneColumn.html.md} +3 -3
  40. data/doc_out/CampaignNotificationPhoneColumns.html.md +15 -0
  41. data/doc_out/CampaignNotificationUriReference.html.md +14 -0
  42. data/doc_out/CampaignProgressNotification.html.md +17 -0
  43. data/doc_out/CampaignProgressNotificationUriReference.html.md +14 -0
  44. data/doc_out/CampaignRule.html.md +2 -2
  45. data/doc_out/CampaignRuleActionEntities.html.md +1 -1
  46. data/doc_out/CampaignRuleEntityListing.html.md +2 -2
  47. data/doc_out/CampaignRuleNotification.html.md +23 -0
  48. data/doc_out/CampaignRuleNotificationCampaignRuleAction.html.md +17 -0
  49. data/doc_out/CampaignRuleNotificationCampaignRuleActionEntities.html.md +16 -0
  50. data/doc_out/CampaignRuleNotificationCampaignRuleActions.html.md +17 -0
  51. data/doc_out/CampaignRuleNotificationCampaignRuleCondition.html.md +16 -0
  52. data/doc_out/CampaignRuleNotificationCampaignRuleConditions.html.md +16 -0
  53. data/doc_out/CampaignRuleNotificationCampaignRuleEntities.html.md +15 -0
  54. data/doc_out/CampaignScheduleNotification.html.md +21 -0
  55. data/doc_out/CampaignScheduleNotificationIntervals.html.md +15 -0
  56. data/doc_out/CampaignScheduleNotificationScheduleInterval.html.md +15 -0
  57. data/doc_out/CampaignScheduleNotificationUriReference.html.md +14 -0
  58. data/doc_out/CampaignSequence.html.md +1 -1
  59. data/doc_out/CampaignSequenceEntityListing.html.md +2 -2
  60. data/doc_out/CampaignSequenceNotification.html.md +23 -0
  61. data/doc_out/CampaignSequenceNotificationUriReference.html.md +14 -0
  62. data/doc_out/CertificateAuthorityEntityListing.html.md +2 -2
  63. data/doc_out/CertificateDetails.html.md +3 -3
  64. data/doc_out/ChannelEntityListing.html.md +2 -2
  65. data/doc_out/ChatConversationEntityListing.html.md +2 -2
  66. data/doc_out/ChatMediaParticipant.html.md +3 -3
  67. data/doc_out/CobrowseConversationEntityListing.html.md +2 -2
  68. data/doc_out/CobrowseMediaParticipant.html.md +3 -3
  69. data/doc_out/CommandStatusEntityListing.html.md +2 -2
  70. data/doc_out/Condition.html.md +1 -1
  71. data/doc_out/ContactListEntityListing.html.md +2 -2
  72. data/doc_out/ContactListNotification.html.md +25 -0
  73. data/doc_out/ContactListNotificationImportStatus.html.md +18 -0
  74. data/doc_out/ContactListNotificationPhoneColumn_.html.md +16 -0
  75. data/doc_out/ContactListNotificationPhoneColumns.html.md +16 -0
  76. data/doc_out/ContactListNotificationUriReference.html.md +14 -0
  77. data/doc_out/ContactSort.html.md +1 -1
  78. data/doc_out/ContentQueryRequest.html.md +1 -1
  79. data/doc_out/ContentSortItem.html.md +1 -1
  80. data/doc_out/ConversationChat.html.md +1 -1
  81. data/doc_out/ConversationEntityListing.html.md +2 -2
  82. data/doc_out/ConversationNotificationDialerPreview.html.md +1 -1
  83. data/doc_out/CurrentUserScheduleRequestBody.html.md +14 -0
  84. data/doc_out/CustomerInteractionCenter.html.md +1 -1
  85. data/doc_out/DIDEntityListing.html.md +2 -2
  86. data/doc_out/DIDPoolEntityListing.html.md +2 -2
  87. data/doc_out/DecisionsFileMetadataEntityListing.html.md +2 -2
  88. data/doc_out/DialerContact.html.md +1 -1
  89. data/doc_out/DncListEntityListing.html.md +2 -2
  90. data/doc_out/DncListNotification.html.md +24 -0
  91. data/doc_out/DncListNotificationImportStatus.html.md +18 -0
  92. data/doc_out/Document.html.md +1 -1
  93. data/doc_out/DocumentAudit.html.md +1 -1
  94. data/doc_out/DocumentAuditEntityListing.html.md +2 -2
  95. data/doc_out/DocumentEntityListing.html.md +2 -2
  96. data/doc_out/DocumentUpdate.html.md +1 -1
  97. data/doc_out/DomainCapabilities.html.md +4 -4
  98. data/doc_out/DomainEdgeSoftwareUpdateDto.html.md +2 -2
  99. data/doc_out/DomainEdgeSoftwareVersionDto.html.md +2 -2
  100. data/doc_out/DomainEdgeSoftwareVersionDtoEntityListing.html.md +2 -2
  101. data/doc_out/DomainEntityListing.html.md +2 -2
  102. data/doc_out/DomainEntityListingEvaluationForm.html.md +2 -2
  103. data/doc_out/DomainEntityListingQueryResult.html.md +2 -2
  104. data/doc_out/DomainLogicalInterface.html.md +3 -3
  105. data/doc_out/DomainNetworkAddress.html.md +1 -1
  106. data/doc_out/DomainNetworkCommandResponse.html.md +1 -1
  107. data/doc_out/DomainNetworkRoute.html.md +1 -1
  108. data/doc_out/DomainOrganizationRole.html.md +3 -3
  109. data/doc_out/DomainOrganizationRoleCreate.html.md +3 -3
  110. data/doc_out/DomainOrganizationRoleUpdate.html.md +3 -3
  111. data/doc_out/DomainPermission.html.md +1 -1
  112. data/doc_out/DomainPermissionPolicy.html.md +1 -1
  113. data/doc_out/DomainPhysicalCapabilities.html.md +2 -2
  114. data/doc_out/Edge.html.md +2 -2
  115. data/doc_out/EdgeAutoUpdateConfig.html.md +2 -2
  116. data/doc_out/EdgeEntityListing.html.md +2 -2
  117. data/doc_out/EdgeGroup.html.md +1 -1
  118. data/doc_out/EdgeGroupEntityListing.html.md +2 -2
  119. data/doc_out/EdgeLineEntityListing.html.md +2 -2
  120. data/doc_out/EdgeLogsJobRequest.html.md +1 -1
  121. data/doc_out/Email.html.md +1 -1
  122. data/doc_out/EmailConversationEntityListing.html.md +2 -2
  123. data/doc_out/EmailMediaParticipant.html.md +3 -3
  124. data/doc_out/EmailMessageListing.html.md +2 -2
  125. data/doc_out/EncryptionKeyEntityListing.html.md +2 -2
  126. data/doc_out/Endpoint.html.md +1 -1
  127. data/doc_out/EndpointEntityListing.html.md +2 -2
  128. data/doc_out/Evaluation.html.md +4 -4
  129. data/doc_out/EvaluationEntityListing.html.md +2 -2
  130. data/doc_out/EvaluationForm.html.md +1 -1
  131. data/doc_out/EvaluationFormEntityListing.html.md +2 -2
  132. data/doc_out/EvaluationScoringSet.html.md +1 -1
  133. data/doc_out/EvaluatorActivityEntityListing.html.md +2 -2
  134. data/doc_out/ExportUriNotification.html.md +15 -0
  135. data/doc_out/ExtensionEntityListing.html.md +2 -2
  136. data/doc_out/ExtensionPoolEntityListing.html.md +2 -2
  137. data/doc_out/FaxDocument.html.md +1 -1
  138. data/doc_out/FaxDocumentEntityListing.html.md +2 -2
  139. data/doc_out/FieldList.html.md +3 -3
  140. data/doc_out/Geolocation.html.md +1 -1
  141. data/doc_out/GeolocationSettings.html.md +1 -1
  142. data/doc_out/GreetingListing.html.md +2 -2
  143. data/doc_out/Group.html.md +1 -1
  144. data/doc_out/GroupEntityListing.html.md +2 -2
  145. data/doc_out/GroupUpdate.html.md +1 -1
  146. data/doc_out/HeartBeatAlertContainer.html.md +2 -2
  147. data/doc_out/HeartBeatRule.html.md +2 -2
  148. data/doc_out/HeartBeatRuleContainer.html.md +2 -2
  149. data/doc_out/ImportStatusNotification.html.md +18 -0
  150. data/doc_out/InboundDomain.html.md +1 -1
  151. data/doc_out/InboundDomainEntityListing.html.md +2 -2
  152. data/doc_out/InboundRouteEntityListing.html.md +2 -2
  153. data/doc_out/InitiateScreenRecording.html.md +1 -1
  154. data/doc_out/InteractionStatsAlert.html.md +1 -1
  155. data/doc_out/InteractionStatsAlertContainer.html.md +2 -2
  156. data/doc_out/InteractionStatsRule.html.md +2 -2
  157. data/doc_out/InteractionStatsRuleContainer.html.md +2 -2
  158. data/doc_out/JsonNode.html.md +20 -20
  159. data/doc_out/KeywordSetEntityListing.html.md +2 -2
  160. data/doc_out/LanguageEntityListing.html.md +2 -2
  161. data/doc_out/LibraryEntityListing.html.md +2 -2
  162. data/doc_out/LineBaseEntityListing.html.md +2 -2
  163. data/doc_out/LineEntityListing.html.md +2 -2
  164. data/doc_out/LineStatus.html.md +1 -1
  165. data/doc_out/LocalEncryptionConfigurationListing.html.md +2 -2
  166. data/doc_out/LocationDefinition.html.md +1 -1
  167. data/doc_out/LogicalInterfaceEntityListing.html.md +2 -2
  168. data/doc_out/MediaParticipantRequest.html.md +5 -5
  169. data/doc_out/MeteredEvaluationAssignment.html.md +1 -1
  170. data/doc_out/OAuthClientEntityListing.html.md +2 -2
  171. data/doc_out/OAuthProvider.html.md +1 -1
  172. data/doc_out/OAuthProviderEntityListing.html.md +2 -2
  173. data/doc_out/Okta.html.md +1 -1
  174. data/doc_out/OneLogin.html.md +1 -1
  175. data/doc_out/OrgMediaUtilization.html.md +1 -1
  176. data/doc_out/Organization.html.md +1 -1
  177. data/doc_out/OrganizationPresence.html.md +2 -2
  178. data/doc_out/OrganizationPresenceEntityListing.html.md +2 -2
  179. data/doc_out/OrganizationRoleEntityListing.html.md +2 -2
  180. data/doc_out/OrphanRecordingListing.html.md +2 -2
  181. data/doc_out/OutOfOffice.html.md +1 -1
  182. data/doc_out/OutboundRoute.html.md +4 -4
  183. data/doc_out/OutboundRouteBase.html.md +28 -0
  184. data/doc_out/OutboundRouteBaseEntityListing.html.md +22 -0
  185. data/doc_out/OutboundRouteEntityListing.html.md +2 -2
  186. data/doc_out/Parameter.html.md +1 -1
  187. data/doc_out/Participant.html.md +2 -2
  188. data/doc_out/PermissionCollectionEntityListing.html.md +2 -2
  189. data/doc_out/PhoneBaseEntityListing.html.md +2 -2
  190. data/doc_out/PhoneCapabilities.html.md +5 -5
  191. data/doc_out/PhoneEntityListing.html.md +2 -2
  192. data/doc_out/PhoneMetaBaseEntityListing.html.md +2 -2
  193. data/doc_out/PhoneNumberStatus.html.md +1 -1
  194. data/doc_out/PhysicalInterfaceEntityListing.html.md +2 -2
  195. data/doc_out/Policy.html.md +1 -1
  196. data/doc_out/PolicyActions.html.md +3 -3
  197. data/doc_out/PolicyCreate.html.md +1 -1
  198. data/doc_out/PolicyEntityListing.html.md +2 -2
  199. data/doc_out/PureCloud.html.md +1 -1
  200. data/doc_out/QualityAuditPage.html.md +2 -2
  201. data/doc_out/QueryRequest.html.md +1 -1
  202. data/doc_out/QuestionGroup.html.md +4 -4
  203. data/doc_out/QuestionGroupScore.html.md +1 -1
  204. data/doc_out/QuestionScore.html.md +2 -2
  205. data/doc_out/QueueEntityListing.html.md +2 -2
  206. data/doc_out/QueueMember.html.md +1 -1
  207. data/doc_out/QueueMemberEntityListing.html.md +2 -2
  208. data/doc_out/ReportMetaDataEntityListing.html.md +2 -2
  209. data/doc_out/ReportRunEntryEntityDomainListing.html.md +2 -2
  210. data/doc_out/ReportSchedule.html.md +1 -1
  211. data/doc_out/ReportScheduleEntityListing.html.md +2 -2
  212. data/doc_out/ResourcePermissionPolicy.html.md +1 -1
  213. data/doc_out/ResponseEntityList.html.md +2 -2
  214. data/doc_out/ResponseEntityListing.html.md +2 -2
  215. data/doc_out/ResponseSetEntityListing.html.md +2 -2
  216. data/doc_out/ResponseSetNotification.html.md +19 -0
  217. data/doc_out/ResponseSetNotificationReaction.html.md +16 -0
  218. data/doc_out/ResponseSetNotificationResponses.html.md +16 -0
  219. data/doc_out/RoutingStatusAlertContainer.html.md +2 -2
  220. data/doc_out/RoutingStatusRule.html.md +2 -2
  221. data/doc_out/RoutingStatusRuleContainer.html.md +2 -2
  222. data/doc_out/RuleSetEntityListing.html.md +2 -2
  223. data/doc_out/RuleSetNotification.html.md +21 -0
  224. data/doc_out/RuleSetNotificationAction.html.md +17 -0
  225. data/doc_out/RuleSetNotificationActions.html.md +17 -0
  226. data/doc_out/RuleSetNotificationCondition.html.md +20 -0
  227. data/doc_out/RuleSetNotificationConditions.html.md +20 -0
  228. data/doc_out/RuleSetNotificationRule.html.md +19 -0
  229. data/doc_out/RuleSetNotificationRules.html.md +19 -0
  230. data/doc_out/RuleSetNotificationUriReference.html.md +14 -0
  231. data/doc_out/Salesforce.html.md +1 -1
  232. data/doc_out/SchemaCategoryEntityListing.html.md +2 -2
  233. data/doc_out/SchemaReferenceEntityListing.html.md +2 -2
  234. data/doc_out/ScreenRecordingSessionListing.html.md +2 -2
  235. data/doc_out/Screenshare.html.md +1 -1
  236. data/doc_out/ScriptEntityListing.html.md +2 -2
  237. data/doc_out/SecurityProfileEntityListing.html.md +2 -2
  238. data/doc_out/SequenceScheduleNotification.html.md +21 -0
  239. data/doc_out/SequenceScheduleNotificationScheduleInterval.html.md +15 -0
  240. data/doc_out/SequenceScheduleNotificationUriReference.html.md +14 -0
  241. data/doc_out/ShareEntityListing.html.md +2 -2
  242. data/doc_out/Site.html.md +1 -1
  243. data/doc_out/SiteEntityListing.html.md +2 -2
  244. data/doc_out/SkillEntityListing.html.md +2 -2
  245. data/doc_out/SocialExpression.html.md +1 -1
  246. data/doc_out/SortItem.html.md +1 -1
  247. data/doc_out/StationEntityListing.html.md +2 -2
  248. data/doc_out/StationsApi.html.md +2 -0
  249. data/doc_out/TagValue.html.md +1 -1
  250. data/doc_out/TagValueEntityListing.html.md +2 -2
  251. data/doc_out/TelephonyProvidersEdgeApi.html.md +311 -0
  252. data/doc_out/TimeAllowed.html.md +1 -1
  253. data/doc_out/TimeOffRequest.html.md +2 -2
  254. data/doc_out/TimeOffRequestPatch.html.md +1 -1
  255. data/doc_out/TimeZoneEntityListing.html.md +2 -2
  256. data/doc_out/TransferRequest.html.md +1 -1
  257. data/doc_out/Trunk.html.md +1 -1
  258. data/doc_out/TrunkBase.html.md +1 -1
  259. data/doc_out/TrunkBaseEntityListing.html.md +2 -2
  260. data/doc_out/TrunkEntityListing.html.md +2 -2
  261. data/doc_out/TrunkMetabaseEntityListing.html.md +2 -2
  262. data/doc_out/UnreadStatus.html.md +1 -1
  263. data/doc_out/UserEntityListing.html.md +2 -2
  264. data/doc_out/UserPresence.html.md +1 -1
  265. data/doc_out/UserPresenceAlertContainer.html.md +2 -2
  266. data/doc_out/UserPresenceRule.html.md +2 -2
  267. data/doc_out/UserPresenceRuleContainer.html.md +2 -2
  268. data/doc_out/UserQueue.html.md +1 -1
  269. data/doc_out/UserQueueEntityListing.html.md +2 -2
  270. data/doc_out/UserRecording.html.md +1 -1
  271. data/doc_out/UserRecordingEntityListing.html.md +2 -2
  272. data/doc_out/UserScheduleAdherence.html.md +1 -1
  273. data/doc_out/UserSkillEntityListing.html.md +2 -2
  274. data/doc_out/UsersApi.html.md +2 -2
  275. data/doc_out/ValidateAddressResponse.html.md +1 -1
  276. data/doc_out/Video.html.md +3 -3
  277. data/doc_out/VoicemailApi.html.md +9 -3
  278. data/doc_out/VoicemailGroupPolicy.html.md +2 -2
  279. data/doc_out/VoicemailMessage.html.md +2 -2
  280. data/doc_out/VoicemailMessageEntityListing.html.md +2 -2
  281. data/doc_out/VoicemailOrganizationPolicy.html.md +4 -4
  282. data/doc_out/VoicemailUserPolicy.html.md +1 -1
  283. data/doc_out/WorkforceManagementApi.html.md +58 -0
  284. data/doc_out/Workspace.html.md +1 -1
  285. data/doc_out/WorkspaceEntityListing.html.md +2 -2
  286. data/doc_out/WorkspaceMemberEntityListing.html.md +2 -2
  287. data/doc_out/WrapUpCodeMappingNotification.html.md +21 -0
  288. data/doc_out/Wrapup.html.md +1 -1
  289. data/doc_out/WrapupCodeEntityListing.html.md +2 -2
  290. data/doc_out/index.html.md +3 -3
  291. data/lib/purecloud.rb +57 -1
  292. data/lib/purecloud/api/stations_api.rb +3 -0
  293. data/lib/purecloud/api/telephony_providers_edge_api.rb +334 -0
  294. data/lib/purecloud/api/users_api.rb +3 -3
  295. data/lib/purecloud/api/voicemail_api.rb +6 -0
  296. data/lib/purecloud/api/workforce_management_api.rb +57 -0
  297. data/lib/purecloud/api_client.rb +1 -1
  298. data/lib/purecloud/models/adfs.rb +0 -2
  299. data/lib/purecloud/models/agent_activity_entity_listing.rb +13 -13
  300. data/lib/purecloud/models/aggregate_metric_data.rb +1 -1
  301. data/lib/purecloud/models/aggregation_query.rb +0 -2
  302. data/lib/purecloud/models/analytics_conversation.rb +12 -1
  303. data/lib/purecloud/models/analytics_conversation_segment.rb +0 -6
  304. data/lib/purecloud/models/analytics_query_predicate.rb +1 -1
  305. data/lib/purecloud/models/analytics_session.rb +0 -4
  306. data/lib/purecloud/models/attempt_limits_entity_listing.rb +13 -13
  307. data/lib/purecloud/models/attempt_limits_notification.rb +276 -0
  308. data/lib/purecloud/models/attempt_limits_notification_recall_entries.rb +185 -0
  309. data/lib/purecloud/models/attempt_limits_notification_recall_entry.rb +185 -0
  310. data/lib/purecloud/models/attribute_entity_listing.rb +13 -13
  311. data/lib/purecloud/models/audit_message.rb +0 -2
  312. data/lib/purecloud/models/calibration_entity_listing.rb +13 -13
  313. data/lib/purecloud/models/call.rb +0 -8
  314. data/lib/purecloud/models/call_conversation_entity_listing.rb +13 -13
  315. data/lib/purecloud/models/call_forwarding.rb +0 -2
  316. data/lib/purecloud/models/call_media_participant.rb +0 -12
  317. data/lib/purecloud/models/callable_time_set_entity_listing.rb +13 -13
  318. data/lib/purecloud/models/callable_time_set_notification.rb +227 -0
  319. data/lib/purecloud/models/callable_time_set_notification_callable_time.rb +187 -0
  320. data/lib/purecloud/models/callable_time_set_notification_callable_times.rb +187 -0
  321. data/lib/purecloud/models/callable_time_set_notification_time_slot.rb +195 -0
  322. data/lib/purecloud/models/callable_time_set_notification_time_slots.rb +195 -0
  323. data/lib/purecloud/models/callback.rb +12 -5
  324. data/lib/purecloud/models/callback_conversation_entity_listing.rb +13 -13
  325. data/lib/purecloud/models/callback_conversation_notification_dialer_preview.rb +1 -1
  326. data/lib/purecloud/models/callback_media_participant.rb +12 -9
  327. data/lib/purecloud/models/campaign.rb +0 -2
  328. data/lib/purecloud/models/campaign_entity_listing.rb +13 -13
  329. data/lib/purecloud/models/campaign_interaction.rb +0 -2
  330. data/lib/purecloud/models/campaign_notification.rb +471 -0
  331. data/lib/purecloud/models/campaign_notification_contact_sort.rb +204 -0
  332. data/lib/purecloud/models/campaign_notification_error.rb +185 -0
  333. data/lib/purecloud/models/campaign_notification_errors.rb +185 -0
  334. data/lib/purecloud/models/campaign_notification_phone_column.rb +185 -0
  335. data/lib/purecloud/models/{conversation_notification_dialer_preview_phone_number_columns.rb → campaign_notification_phone_columns.rb} +1 -1
  336. data/lib/purecloud/models/campaign_notification_uri_reference.rb +175 -0
  337. data/lib/purecloud/models/campaign_progress_notification.rb +205 -0
  338. data/lib/purecloud/models/campaign_progress_notification_uri_reference.rb +175 -0
  339. data/lib/purecloud/models/campaign_rule.rb +0 -4
  340. data/lib/purecloud/models/campaign_rule_action_entities.rb +0 -2
  341. data/lib/purecloud/models/campaign_rule_entity_listing.rb +13 -13
  342. data/lib/purecloud/models/campaign_rule_notification.rb +269 -0
  343. data/lib/purecloud/models/campaign_rule_notification_campaign_rule_action.rb +216 -0
  344. data/lib/purecloud/models/campaign_rule_notification_campaign_rule_action_entities.rb +199 -0
  345. data/lib/purecloud/models/campaign_rule_notification_campaign_rule_actions.rb +216 -0
  346. data/lib/purecloud/models/campaign_rule_notification_campaign_rule_condition.rb +206 -0
  347. data/lib/purecloud/models/campaign_rule_notification_campaign_rule_conditions.rb +206 -0
  348. data/lib/purecloud/models/campaign_rule_notification_campaign_rule_entities.rb +189 -0
  349. data/lib/purecloud/models/campaign_schedule_notification.rb +247 -0
  350. data/lib/purecloud/models/campaign_schedule_notification_intervals.rb +185 -0
  351. data/lib/purecloud/models/campaign_schedule_notification_schedule_interval.rb +185 -0
  352. data/lib/purecloud/models/campaign_schedule_notification_uri_reference.rb +175 -0
  353. data/lib/purecloud/models/campaign_sequence.rb +0 -2
  354. data/lib/purecloud/models/campaign_sequence_entity_listing.rb +13 -13
  355. data/lib/purecloud/models/campaign_sequence_notification.rb +276 -0
  356. data/lib/purecloud/models/campaign_sequence_notification_uri_reference.rb +175 -0
  357. data/lib/purecloud/models/certificate_authority_entity_listing.rb +13 -13
  358. data/lib/purecloud/models/certificate_details.rb +0 -6
  359. data/lib/purecloud/models/channel_entity_listing.rb +13 -13
  360. data/lib/purecloud/models/chat_conversation_entity_listing.rb +13 -13
  361. data/lib/purecloud/models/chat_media_participant.rb +0 -6
  362. data/lib/purecloud/models/cobrowse_conversation_entity_listing.rb +13 -13
  363. data/lib/purecloud/models/cobrowse_media_participant.rb +0 -6
  364. data/lib/purecloud/models/command_status_entity_listing.rb +13 -13
  365. data/lib/purecloud/models/condition.rb +0 -2
  366. data/lib/purecloud/models/contact_list_entity_listing.rb +13 -13
  367. data/lib/purecloud/models/contact_list_notification.rb +291 -0
  368. data/lib/purecloud/models/contact_list_notification_import_status.rb +224 -0
  369. data/lib/purecloud/models/contact_list_notification_phone_column_.rb +195 -0
  370. data/lib/purecloud/models/contact_list_notification_phone_columns.rb +195 -0
  371. data/lib/purecloud/models/contact_list_notification_uri_reference.rb +175 -0
  372. data/lib/purecloud/models/contact_sort.rb +0 -2
  373. data/lib/purecloud/models/content_query_request.rb +0 -2
  374. data/lib/purecloud/models/content_sort_item.rb +0 -2
  375. data/lib/purecloud/models/conversation_chat.rb +0 -2
  376. data/lib/purecloud/models/conversation_entity_listing.rb +13 -13
  377. data/lib/purecloud/models/conversation_notification_dialer_preview.rb +1 -1
  378. data/lib/purecloud/models/conversation_query.rb +1 -1
  379. data/lib/purecloud/models/current_user_schedule_request_body.rb +178 -0
  380. data/lib/purecloud/models/customer_interaction_center.rb +0 -2
  381. data/lib/purecloud/models/decisions_file_metadata_entity_listing.rb +13 -13
  382. data/lib/purecloud/models/dialer_contact.rb +0 -2
  383. data/lib/purecloud/models/did_entity_listing.rb +13 -13
  384. data/lib/purecloud/models/did_pool_entity_listing.rb +13 -13
  385. data/lib/purecloud/models/dnc_list_entity_listing.rb +13 -13
  386. data/lib/purecloud/models/dnc_list_notification.rb +286 -0
  387. data/lib/purecloud/models/dnc_list_notification_import_status.rb +224 -0
  388. data/lib/purecloud/models/document.rb +0 -2
  389. data/lib/purecloud/models/document_audit.rb +0 -2
  390. data/lib/purecloud/models/document_audit_entity_listing.rb +13 -13
  391. data/lib/purecloud/models/document_entity_listing.rb +13 -13
  392. data/lib/purecloud/models/document_update.rb +0 -2
  393. data/lib/purecloud/models/domain_capabilities.rb +0 -8
  394. data/lib/purecloud/models/domain_edge_software_update_dto.rb +0 -4
  395. data/lib/purecloud/models/domain_edge_software_version_dto.rb +0 -4
  396. data/lib/purecloud/models/domain_edge_software_version_dto_entity_listing.rb +13 -13
  397. data/lib/purecloud/models/domain_entity_listing.rb +13 -13
  398. data/lib/purecloud/models/domain_entity_listing_evaluation_form.rb +13 -13
  399. data/lib/purecloud/models/domain_entity_listing_query_result.rb +13 -13
  400. data/lib/purecloud/models/domain_logical_interface.rb +0 -6
  401. data/lib/purecloud/models/domain_network_address.rb +0 -2
  402. data/lib/purecloud/models/domain_network_command_response.rb +0 -2
  403. data/lib/purecloud/models/domain_network_route.rb +0 -2
  404. data/lib/purecloud/models/domain_organization_role.rb +0 -6
  405. data/lib/purecloud/models/domain_organization_role_create.rb +0 -6
  406. data/lib/purecloud/models/domain_organization_role_update.rb +0 -6
  407. data/lib/purecloud/models/domain_permission.rb +0 -2
  408. data/lib/purecloud/models/domain_permission_policy.rb +0 -2
  409. data/lib/purecloud/models/domain_physical_capabilities.rb +0 -4
  410. data/lib/purecloud/models/edge.rb +0 -4
  411. data/lib/purecloud/models/edge_auto_update_config.rb +4 -4
  412. data/lib/purecloud/models/edge_entity_listing.rb +13 -13
  413. data/lib/purecloud/models/edge_group.rb +0 -2
  414. data/lib/purecloud/models/edge_group_entity_listing.rb +13 -13
  415. data/lib/purecloud/models/edge_line_entity_listing.rb +13 -13
  416. data/lib/purecloud/models/edge_logs_job_request.rb +0 -2
  417. data/lib/purecloud/models/email.rb +0 -2
  418. data/lib/purecloud/models/email_conversation_entity_listing.rb +13 -13
  419. data/lib/purecloud/models/email_media_participant.rb +0 -6
  420. data/lib/purecloud/models/email_message_listing.rb +13 -13
  421. data/lib/purecloud/models/encryption_key_entity_listing.rb +13 -13
  422. data/lib/purecloud/models/endpoint.rb +0 -2
  423. data/lib/purecloud/models/endpoint_entity_listing.rb +13 -13
  424. data/lib/purecloud/models/evaluation.rb +0 -8
  425. data/lib/purecloud/models/evaluation_entity_listing.rb +13 -13
  426. data/lib/purecloud/models/evaluation_form.rb +0 -2
  427. data/lib/purecloud/models/evaluation_form_entity_listing.rb +13 -13
  428. data/lib/purecloud/models/evaluation_scoring_set.rb +0 -2
  429. data/lib/purecloud/models/evaluator_activity_entity_listing.rb +13 -13
  430. data/lib/purecloud/models/export_uri_notification.rb +185 -0
  431. data/lib/purecloud/models/extension_entity_listing.rb +13 -13
  432. data/lib/purecloud/models/extension_pool_entity_listing.rb +13 -13
  433. data/lib/purecloud/models/fax_document.rb +0 -2
  434. data/lib/purecloud/models/fax_document_entity_listing.rb +13 -13
  435. data/lib/purecloud/models/field_list.rb +0 -6
  436. data/lib/purecloud/models/geolocation.rb +0 -2
  437. data/lib/purecloud/models/geolocation_settings.rb +0 -2
  438. data/lib/purecloud/models/greeting_listing.rb +13 -13
  439. data/lib/purecloud/models/group.rb +0 -2
  440. data/lib/purecloud/models/group_entity_listing.rb +13 -13
  441. data/lib/purecloud/models/group_update.rb +0 -2
  442. data/lib/purecloud/models/heart_beat_alert_container.rb +13 -13
  443. data/lib/purecloud/models/heart_beat_rule.rb +0 -4
  444. data/lib/purecloud/models/heart_beat_rule_container.rb +13 -13
  445. data/lib/purecloud/models/import_status_notification.rb +224 -0
  446. data/lib/purecloud/models/inbound_domain.rb +0 -2
  447. data/lib/purecloud/models/inbound_domain_entity_listing.rb +13 -13
  448. data/lib/purecloud/models/inbound_route_entity_listing.rb +13 -13
  449. data/lib/purecloud/models/initiate_screen_recording.rb +0 -2
  450. data/lib/purecloud/models/interaction_stats_alert.rb +0 -2
  451. data/lib/purecloud/models/interaction_stats_alert_container.rb +13 -13
  452. data/lib/purecloud/models/interaction_stats_rule.rb +0 -4
  453. data/lib/purecloud/models/interaction_stats_rule_container.rb +13 -13
  454. data/lib/purecloud/models/json_node.rb +0 -40
  455. data/lib/purecloud/models/keyword_set_entity_listing.rb +13 -13
  456. data/lib/purecloud/models/language_entity_listing.rb +13 -13
  457. data/lib/purecloud/models/library_entity_listing.rb +13 -13
  458. data/lib/purecloud/models/line_base_entity_listing.rb +13 -13
  459. data/lib/purecloud/models/line_entity_listing.rb +13 -13
  460. data/lib/purecloud/models/line_status.rb +0 -2
  461. data/lib/purecloud/models/local_encryption_configuration_listing.rb +13 -13
  462. data/lib/purecloud/models/location_definition.rb +0 -2
  463. data/lib/purecloud/models/logical_interface_entity_listing.rb +13 -13
  464. data/lib/purecloud/models/media_participant_request.rb +0 -10
  465. data/lib/purecloud/models/metered_evaluation_assignment.rb +0 -2
  466. data/lib/purecloud/models/o_auth_client_entity_listing.rb +13 -13
  467. data/lib/purecloud/models/o_auth_provider.rb +0 -2
  468. data/lib/purecloud/models/o_auth_provider_entity_listing.rb +13 -13
  469. data/lib/purecloud/models/okta.rb +0 -2
  470. data/lib/purecloud/models/one_login.rb +0 -2
  471. data/lib/purecloud/models/org_media_utilization.rb +0 -2
  472. data/lib/purecloud/models/organization.rb +0 -2
  473. data/lib/purecloud/models/organization_presence.rb +0 -4
  474. data/lib/purecloud/models/organization_presence_entity_listing.rb +13 -13
  475. data/lib/purecloud/models/organization_role_entity_listing.rb +13 -13
  476. data/lib/purecloud/models/orphan_recording_listing.rb +13 -13
  477. data/lib/purecloud/models/out_of_office.rb +0 -2
  478. data/lib/purecloud/models/outbound_route.rb +23 -25
  479. data/lib/purecloud/models/outbound_route_base.rb +344 -0
  480. data/lib/purecloud/models/outbound_route_base_entity_listing.rb +257 -0
  481. data/lib/purecloud/models/outbound_route_entity_listing.rb +13 -13
  482. data/lib/purecloud/models/parameter.rb +0 -2
  483. data/lib/purecloud/models/participant.rb +0 -4
  484. data/lib/purecloud/models/permission_collection_entity_listing.rb +13 -13
  485. data/lib/purecloud/models/phone_base_entity_listing.rb +13 -13
  486. data/lib/purecloud/models/phone_capabilities.rb +0 -10
  487. data/lib/purecloud/models/phone_entity_listing.rb +13 -13
  488. data/lib/purecloud/models/phone_meta_base_entity_listing.rb +13 -13
  489. data/lib/purecloud/models/phone_number_status.rb +0 -2
  490. data/lib/purecloud/models/physical_interface_entity_listing.rb +13 -13
  491. data/lib/purecloud/models/policy.rb +0 -2
  492. data/lib/purecloud/models/policy_actions.rb +0 -6
  493. data/lib/purecloud/models/policy_create.rb +0 -2
  494. data/lib/purecloud/models/policy_entity_listing.rb +13 -13
  495. data/lib/purecloud/models/pure_cloud.rb +0 -2
  496. data/lib/purecloud/models/quality_audit_page.rb +13 -13
  497. data/lib/purecloud/models/query_request.rb +0 -2
  498. data/lib/purecloud/models/question_group.rb +0 -8
  499. data/lib/purecloud/models/question_group_score.rb +0 -2
  500. data/lib/purecloud/models/question_score.rb +0 -4
  501. data/lib/purecloud/models/queue_entity_listing.rb +13 -13
  502. data/lib/purecloud/models/queue_member.rb +0 -2
  503. data/lib/purecloud/models/queue_member_entity_listing.rb +13 -13
  504. data/lib/purecloud/models/report_meta_data_entity_listing.rb +13 -13
  505. data/lib/purecloud/models/report_run_entry_entity_domain_listing.rb +13 -13
  506. data/lib/purecloud/models/report_schedule.rb +0 -2
  507. data/lib/purecloud/models/report_schedule_entity_listing.rb +13 -13
  508. data/lib/purecloud/models/resource_permission_policy.rb +0 -2
  509. data/lib/purecloud/models/response_entity_list.rb +13 -13
  510. data/lib/purecloud/models/response_entity_listing.rb +13 -13
  511. data/lib/purecloud/models/response_set_entity_listing.rb +13 -13
  512. data/lib/purecloud/models/response_set_notification.rb +227 -0
  513. data/lib/purecloud/models/response_set_notification_reaction.rb +204 -0
  514. data/lib/purecloud/models/response_set_notification_responses.rb +204 -0
  515. data/lib/purecloud/models/routing_status_alert_container.rb +13 -13
  516. data/lib/purecloud/models/routing_status_rule.rb +0 -4
  517. data/lib/purecloud/models/routing_status_rule_container.rb +13 -13
  518. data/lib/purecloud/models/rule_set_entity_listing.rb +13 -13
  519. data/lib/purecloud/models/rule_set_notification.rb +247 -0
  520. data/lib/purecloud/models/rule_set_notification_action.rb +207 -0
  521. data/lib/purecloud/models/rule_set_notification_actions.rb +207 -0
  522. data/lib/purecloud/models/rule_set_notification_condition.rb +255 -0
  523. data/lib/purecloud/models/rule_set_notification_conditions.rb +255 -0
  524. data/lib/purecloud/models/rule_set_notification_rule.rb +229 -0
  525. data/lib/purecloud/models/rule_set_notification_rules.rb +229 -0
  526. data/lib/purecloud/models/rule_set_notification_uri_reference.rb +175 -0
  527. data/lib/purecloud/models/salesforce.rb +0 -2
  528. data/lib/purecloud/models/schema_category_entity_listing.rb +13 -13
  529. data/lib/purecloud/models/schema_reference_entity_listing.rb +13 -13
  530. data/lib/purecloud/models/screen_recording_session_listing.rb +13 -13
  531. data/lib/purecloud/models/screenshare.rb +0 -2
  532. data/lib/purecloud/models/script_entity_listing.rb +13 -13
  533. data/lib/purecloud/models/security_profile_entity_listing.rb +13 -13
  534. data/lib/purecloud/models/sequence_schedule_notification.rb +247 -0
  535. data/lib/purecloud/models/sequence_schedule_notification_schedule_interval.rb +185 -0
  536. data/lib/purecloud/models/sequence_schedule_notification_uri_reference.rb +175 -0
  537. data/lib/purecloud/models/share_entity_listing.rb +13 -13
  538. data/lib/purecloud/models/site.rb +0 -2
  539. data/lib/purecloud/models/site_entity_listing.rb +13 -13
  540. data/lib/purecloud/models/skill_entity_listing.rb +13 -13
  541. data/lib/purecloud/models/social_expression.rb +0 -2
  542. data/lib/purecloud/models/sort_item.rb +0 -2
  543. data/lib/purecloud/models/station_entity_listing.rb +13 -13
  544. data/lib/purecloud/models/tag_value.rb +0 -2
  545. data/lib/purecloud/models/tag_value_entity_listing.rb +13 -13
  546. data/lib/purecloud/models/time_allowed.rb +0 -2
  547. data/lib/purecloud/models/time_off_request.rb +0 -4
  548. data/lib/purecloud/models/time_off_request_patch.rb +0 -2
  549. data/lib/purecloud/models/time_zone_entity_listing.rb +13 -13
  550. data/lib/purecloud/models/transfer_request.rb +0 -2
  551. data/lib/purecloud/models/trunk.rb +0 -2
  552. data/lib/purecloud/models/trunk_base.rb +0 -2
  553. data/lib/purecloud/models/trunk_base_entity_listing.rb +13 -13
  554. data/lib/purecloud/models/trunk_entity_listing.rb +13 -13
  555. data/lib/purecloud/models/trunk_metabase_entity_listing.rb +13 -13
  556. data/lib/purecloud/models/unread_status.rb +0 -2
  557. data/lib/purecloud/models/user_entity_listing.rb +13 -13
  558. data/lib/purecloud/models/user_presence.rb +0 -2
  559. data/lib/purecloud/models/user_presence_alert_container.rb +13 -13
  560. data/lib/purecloud/models/user_presence_rule.rb +0 -4
  561. data/lib/purecloud/models/user_presence_rule_container.rb +13 -13
  562. data/lib/purecloud/models/user_queue.rb +0 -2
  563. data/lib/purecloud/models/user_queue_entity_listing.rb +13 -13
  564. data/lib/purecloud/models/user_recording.rb +0 -2
  565. data/lib/purecloud/models/user_recording_entity_listing.rb +13 -13
  566. data/lib/purecloud/models/user_schedule_adherence.rb +0 -2
  567. data/lib/purecloud/models/user_skill_entity_listing.rb +13 -13
  568. data/lib/purecloud/models/validate_address_response.rb +0 -2
  569. data/lib/purecloud/models/video.rb +0 -6
  570. data/lib/purecloud/models/voicemail_group_policy.rb +0 -4
  571. data/lib/purecloud/models/voicemail_message.rb +0 -4
  572. data/lib/purecloud/models/voicemail_message_entity_listing.rb +13 -13
  573. data/lib/purecloud/models/voicemail_organization_policy.rb +0 -8
  574. data/lib/purecloud/models/voicemail_user_policy.rb +0 -2
  575. data/lib/purecloud/models/workspace.rb +0 -2
  576. data/lib/purecloud/models/workspace_entity_listing.rb +13 -13
  577. data/lib/purecloud/models/workspace_member_entity_listing.rb +13 -13
  578. data/lib/purecloud/models/wrap_up_code_mapping_notification.rb +258 -0
  579. data/lib/purecloud/models/wrapup.rb +0 -2
  580. data/lib/purecloud/models/wrapup_code_entity_listing.rb +13 -13
  581. data/lib/purecloud/version.rb +1 -1
  582. data/newVersion.md +1 -1
  583. data/swagger.json +1 -1
  584. data/version.json +1 -1
  585. metadata +116 -4
@@ -11,7 +11,7 @@ title: TransferRequest
11
11
  | **address** | **String** | The phone number or address of the transfer target. | [optional] |
12
12
  | **user_name** | **String** | The user name of the transfer target. | [optional] |
13
13
  | **queue_id** | **String** | The queue ID of the transfer target. | [optional] |
14
- | **voicemail** | **BOOLEAN** | If true, then transfer to the user's voicemail. | [optional] [default to false]|
14
+ | **voicemail** | **BOOLEAN** | If true, then transfer to the user's voicemail. | [optional] |
15
15
  {: class="table table-striped"}
16
16
 
17
17
 
@@ -23,7 +23,7 @@ title: Trunk
23
23
  | **trunk_base** | [**UriReference**](UriReference.html) | The trunk base configuration used on this trunk. | [optional] |
24
24
  | **trunk_metabase** | [**UriReference**](UriReference.html) | The metabase used to create this trunk. | [optional] |
25
25
  | **edge_group** | [**UriReference**](UriReference.html) | The edge group associated with this trunk. | [optional] |
26
- | **enabled** | **BOOLEAN** | True if this trunk is in-service. This comes from the trunk_enabled property of the referenced trunk base. | [optional] [default to false]|
26
+ | **enabled** | **BOOLEAN** | True if this trunk is in-service. This comes from the trunk_enabled property of the referenced trunk base. | [optional] |
27
27
  | **self_uri** | **String** | The URI for this object | [optional] |
28
28
  {: class="table table-striped"}
29
29
 
@@ -21,7 +21,7 @@ title: TrunkBase
21
21
  | **trunk_metabase** | [**UriReference**](UriReference.html) | The meta-base this trunk is based on. | |
22
22
  | **properties** | **Hash<String, Object>** | | [optional] |
23
23
  | **trunk_type** | **String** | The type of this trunk base. | |
24
- | **managed** | **BOOLEAN** | Is this trunk being managed remotely. | [optional] [default to false]|
24
+ | **managed** | **BOOLEAN** | Is this trunk being managed remotely. | [optional] |
25
25
  | **self_uri** | **String** | The URI for this object | [optional] |
26
26
  {: class="table table-striped"}
27
27
 
@@ -13,9 +13,9 @@ title: TrunkBaseEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
17
- | **next_uri** | **String** | | [optional] |
18
16
  | **last_uri** | **String** | | [optional] |
17
+ | **next_uri** | **String** | | [optional] |
18
+ | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -13,9 +13,9 @@ title: TrunkEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
17
- | **next_uri** | **String** | | [optional] |
18
16
  | **last_uri** | **String** | | [optional] |
17
+ | **next_uri** | **String** | | [optional] |
18
+ | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -13,9 +13,9 @@ title: TrunkMetabaseEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
17
- | **next_uri** | **String** | | [optional] |
18
16
  | **last_uri** | **String** | | [optional] |
17
+ | **next_uri** | **String** | | [optional] |
18
+ | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -7,7 +7,7 @@ title: UnreadStatus
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
- | **unread** | **BOOLEAN** | Sets if the alert is read or unread. | [optional] [default to false]|
10
+ | **unread** | **BOOLEAN** | Sets if the alert is read or unread. | [optional] |
11
11
  {: class="table table-striped"}
12
12
 
13
13
 
@@ -13,9 +13,9 @@ title: UserEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
17
- | **next_uri** | **String** | | [optional] |
18
16
  | **last_uri** | **String** | | [optional] |
17
+ | **next_uri** | **String** | | [optional] |
18
+ | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -10,7 +10,7 @@ title: UserPresence
10
10
  | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
11
  | **name** | **String** | | [optional] |
12
12
  | **source** | **String** | Represents the source where the Presence was set. Some examples are: PURECLOUD, LYNC, OUTLOOK, etc. | [optional] |
13
- | **primary** | **BOOLEAN** | A boolean used to tell whether or not to set this presence source as the primary on a PATCH | [optional] [default to false]|
13
+ | **primary** | **BOOLEAN** | A boolean used to tell whether or not to set this presence source as the primary on a PATCH | [optional] |
14
14
  | **presence_definition** | [**OrganizationPresence**](OrganizationPresence.html) | | [optional] |
15
15
  | **message** | **String** | | [optional] |
16
16
  | **modified_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
@@ -13,9 +13,9 @@ title: UserPresenceAlertContainer
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
17
- | **next_uri** | **String** | | [optional] |
18
16
  | **last_uri** | **String** | | [optional] |
17
+ | **next_uri** | **String** | | [optional] |
18
+ | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -13,8 +13,8 @@ title: UserPresenceRule
13
13
  | **presence_type** | **String** | Indicates to which presence type the presence value belongs. | |
14
14
  | **presence_value** | **String** | The Org's UUID or Systems enum constance indicating the presence of concern. | |
15
15
  | **presence_limit_in_seconds** | **Integer** | The number of seconds to wait before alerting based upon the user's presence. | |
16
- | **enabled** | **BOOLEAN** | Indicates if the rule is enabled. | [default to false]|
17
- | **in_alarm** | **BOOLEAN** | Indicates if the rule is in alarm state. | [optional] [default to false]|
16
+ | **enabled** | **BOOLEAN** | Indicates if the rule is enabled. | |
17
+ | **in_alarm** | **BOOLEAN** | Indicates if the rule is in alarm state. | [optional] |
18
18
  | **notification_users** | [**Array<User>**](User.html) | The ids of users who will be notified of alarm state change. | |
19
19
  | **alert_types** | **Array<String>** | A collection of notification methods. | |
20
20
  | **self_uri** | **String** | The URI for this object | [optional] |
@@ -13,9 +13,9 @@ title: UserPresenceRuleContainer
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
17
- | **next_uri** | **String** | | [optional] |
18
16
  | **last_uri** | **String** | | [optional] |
17
+ | **next_uri** | **String** | | [optional] |
18
+ | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -26,7 +26,7 @@ title: UserQueue
26
26
  | **calling_party_name** | **String** | The name to use for caller identification for outbound calls from this queue. | [optional] |
27
27
  | **calling_party_number** | **String** | The phone number to use for caller identification for outbound calls from this queue. | [optional] |
28
28
  | **outbound_email_address** | [**QueueEmailAddress**](QueueEmailAddress.html) | | [optional] |
29
- | **joined** | **BOOLEAN** | | [optional] [default to false]|
29
+ | **joined** | **BOOLEAN** | | [optional] |
30
30
  | **member_count** | **Integer** | | [optional] |
31
31
  | **self_uri** | **String** | The URI for this object | [optional] |
32
32
  {: class="table table-striped"}
@@ -13,9 +13,9 @@ title: UserQueueEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
17
- | **next_uri** | **String** | | [optional] |
18
16
  | **last_uri** | **String** | | [optional] |
17
+ | **next_uri** | **String** | | [optional] |
18
+ | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -18,7 +18,7 @@ title: UserRecording
18
18
  | **content_length** | **Integer** | | [optional] |
19
19
  | **duration_milliseconds** | **Integer** | | [optional] |
20
20
  | **thumbnails** | [**Array<DocumentThumbnail>**](DocumentThumbnail.html) | | [optional] |
21
- | **read** | **BOOLEAN** | | [optional] [default to false]|
21
+ | **read** | **BOOLEAN** | | [optional] |
22
22
  | **self_uri** | **String** | The URI for this object | [optional] |
23
23
  {: class="table table-striped"}
24
24
 
@@ -13,9 +13,9 @@ title: UserRecordingEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
17
- | **next_uri** | **String** | | [optional] |
18
16
  | **last_uri** | **String** | | [optional] |
17
+ | **next_uri** | **String** | | [optional] |
18
+ | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -16,7 +16,7 @@ title: UserScheduleAdherence
16
16
  | **organization_secondary_presence_id** | **String** | Organization Secondary Presence Id. | [optional] |
17
17
  | **routing_status** | **String** | Actual underlying routing status, used to determine whether a user is actually in adherence when OnQueue | [optional] |
18
18
  | **actual_activity_category** | **String** | Activity in which the user is actually engaged | [optional] |
19
- | **is_out_of_office** | **BOOLEAN** | Whether the user is marked OutOfOffice | [optional] [default to false]|
19
+ | **is_out_of_office** | **BOOLEAN** | Whether the user is marked OutOfOffice | [optional] |
20
20
  | **adherence_state** | **String** | The user's current adherence state | [optional] |
21
21
  | **impact** | **String** | The impact of the user's current adherenceState | [optional] |
22
22
  | **time_of_adherence_change** | **String** | Time when the user entered the current adherenceState in ISO-8601 format | [optional] |
@@ -13,9 +13,9 @@ title: UserSkillEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
17
- | **next_uri** | **String** | | [optional] |
18
16
  | **last_uri** | **String** | | [optional] |
17
+ | **next_uri** | **String** | | [optional] |
18
+ | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -1581,7 +1581,7 @@ Name | Type | Description | Notes
1581
1581
 
1582
1582
  <a name="patch_user_id_queues"></a>
1583
1583
 
1584
- ## -[**UserQueue**](UserQueue.html) patch_user_id_queues(user_id, body)
1584
+ ## -[**UserQueueEntityListing**](UserQueueEntityListing.html) patch_user_id_queues(user_id, body)
1585
1585
 
1586
1586
  Join or unjoin a set of queues for a user
1587
1587
 
@@ -1629,7 +1629,7 @@ Name | Type | Description | Notes
1629
1629
 
1630
1630
  ### Return type
1631
1631
 
1632
- [**UserQueue**](UserQueue.html)
1632
+ [**UserQueueEntityListing**](UserQueueEntityListing.html)
1633
1633
 
1634
1634
  ### HTTP request headers
1635
1635
 
@@ -7,7 +7,7 @@ title: ValidateAddressResponse
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
- | **valid** | **BOOLEAN** | Was the passed in address valid | [default to false]|
10
+ | **valid** | **BOOLEAN** | Was the passed in address valid | |
11
11
  | **response** | [**SubscriberResponse**](SubscriberResponse.html) | Subscriber schema | [optional] |
12
12
  {: class="table table-striped"}
13
13
 
@@ -10,9 +10,9 @@ title: Video
10
10
  | **state** | **String** | The connection state of this communication. | [optional] |
11
11
  | **id** | **String** | A globally unique identifier for this communication. | [optional] |
12
12
  | **context** | **String** | The room id context (xmpp jid) for the conference session. | [optional] |
13
- | **audio_muted** | **BOOLEAN** | Indicates whether this participant has muted their outgoing audio. | [optional] [default to false]|
14
- | **video_muted** | **BOOLEAN** | Indicates whether this participant has muted/paused their outgoing video. | [optional] [default to false]|
15
- | **sharing_screen** | **BOOLEAN** | Indicates whether this participant is sharing their screen to the session. | [optional] [default to false]|
13
+ | **audio_muted** | **BOOLEAN** | Indicates whether this participant has muted their outgoing audio. | [optional] |
14
+ | **video_muted** | **BOOLEAN** | Indicates whether this participant has muted/paused their outgoing video. | [optional] |
15
+ | **sharing_screen** | **BOOLEAN** | Indicates whether this participant is sharing their screen to the session. | [optional] |
16
16
  | **peer_count** | **Integer** | The number of peer participants from the perspective of the participant in the conference. | [optional] |
17
17
  | **disconnect_type** | **String** | System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. | [optional] |
18
18
  | **connected_time** | **DateTime** | The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
@@ -547,7 +547,8 @@ end
547
547
  api_instance = PureCloud::VoicemailApi.new
548
548
 
549
549
  opts = {
550
- ids: "ids_example" # String | An optional comma separated list of VoicemailMessage ids
550
+ ids: "ids_example", # String | An optional comma separated list of VoicemailMessage ids
551
+ expand: ["expand_example"] # Array<String> | If the caller is a known user, which fields, if any, to expand
551
552
  }
552
553
 
553
554
  begin
@@ -564,6 +565,7 @@ end
564
565
  Name | Type | Description | Notes
565
566
  ------------- | ------------- | ------------- | -------------
566
567
  **ids** | **String**| An optional comma separated list of VoicemailMessage ids | [optional]
568
+ **expand** | [**Array&lt;String&gt;**](String.html)| If the caller is a known user, which fields, if any, to expand | [optional]
567
569
  {: class="table table-striped"}
568
570
 
569
571
 
@@ -580,7 +582,7 @@ Name | Type | Description | Notes
580
582
 
581
583
  <a name="get_messages_message_id"></a>
582
584
 
583
- ## -[**VoicemailMessage**](VoicemailMessage.html) get_messages_message_id(message_id)
585
+ ## -[**VoicemailMessage**](VoicemailMessage.html) get_messages_message_id(message_id, opts)
584
586
 
585
587
  Get message.
586
588
 
@@ -605,10 +607,13 @@ api_instance = PureCloud::VoicemailApi.new
605
607
 
606
608
  message_id = "message_id_example" # String | Message ID
607
609
 
610
+ opts = {
611
+ expand: ["expand_example"] # Array<String> | If the caller is a known user, which fields, if any, to expand
612
+ }
608
613
 
609
614
  begin
610
615
  #Get message.
611
- result = api_instance.get_messages_message_id(message_id)
616
+ result = api_instance.get_messages_message_id(message_id, opts)
612
617
  p result
613
618
  rescue PureCloud::ApiError => e
614
619
  puts "Exception when calling VoicemailApi->get_messages_message_id: #{e}"
@@ -620,6 +625,7 @@ end
620
625
  Name | Type | Description | Notes
621
626
  ------------- | ------------- | ------------- | -------------
622
627
  **message_id** | **String**| Message ID |
628
+ **expand** | [**Array&lt;String&gt;**](String.html)| If the caller is a known user, which fields, if any, to expand | [optional]
623
629
  {: class="table table-striped"}
624
630
 
625
631
 
@@ -9,8 +9,8 @@ title: VoicemailGroupPolicy
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **name** | **String** | | [optional] |
11
11
  | **group** | [**Group**](Group.html) | The group associated with the policy | [optional] |
12
- | **enabled** | **BOOLEAN** | Whether voicemail is enabled for the group | [optional] [default to false]|
13
- | **send_email_notifications** | **BOOLEAN** | Whether email notifications are sent to group members when a new voicemail is received | [optional] [default to false]|
12
+ | **enabled** | **BOOLEAN** | Whether voicemail is enabled for the group | [optional] |
13
+ | **send_email_notifications** | **BOOLEAN** | Whether email notifications are sent to group members when a new voicemail is received | [optional] |
14
14
  | **rotate_calls_secs** | **Integer** | How many seconds to ring before rotating to the next member in the group | [optional] |
15
15
  | **stop_ringing_after_rotations** | **Integer** | How many rotations to go through | [optional] |
16
16
  {: class="table table-striped"}
@@ -9,7 +9,7 @@ title: VoicemailMessage
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
11
  | **conversation** | [**Conversation**](Conversation.html) | The conversation that the voicemail message is associated with | [optional] |
12
- | **read** | **BOOLEAN** | Whether the voicemail message is marked as read | [optional] [default to false]|
12
+ | **read** | **BOOLEAN** | Whether the voicemail message is marked as read | [optional] |
13
13
  | **audio_recording_duration_seconds** | **Integer** | The voicemail message&#39;s audio recording duration in seconds | [optional] |
14
14
  | **audio_recording_size_bytes** | **Integer** | The voicemail message&#39;s audio recording size in bytes | [optional] |
15
15
  | **created_date** | **DateTime** | The date the voicemail message was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
@@ -17,7 +17,7 @@ title: VoicemailMessage
17
17
  | **caller_address** | **String** | The caller address | [optional] |
18
18
  | **caller_name** | **String** | Optionally the name of the caller that left the voicemail message if the caller was a known user | [optional] |
19
19
  | **caller_user** | [**User**](User.html) | Optionally the user that left the voicemail message if the caller was a known user | [optional] |
20
- | **deleted** | **BOOLEAN** | Whether the voicemail message has been marked as deleted | [optional] [default to false]|
20
+ | **deleted** | **BOOLEAN** | Whether the voicemail message has been marked as deleted | [optional] |
21
21
  | **note** | **String** | An optional note | [optional] |
22
22
  | **user** | [**User**](User.html) | The user that the voicemail message belongs to or null which means the voicemail message belongs to a group | [optional] |
23
23
  | **group** | [**Group**](Group.html) | The group that the voicemail message belongs to or null which means the voicemail message belongs to a user | [optional] |
@@ -13,9 +13,9 @@ title: VoicemailMessageEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
17
- | **next_uri** | **String** | | [optional] |
18
16
  | **last_uri** | **String** | | [optional] |
17
+ | **next_uri** | **String** | | [optional] |
18
+ | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -7,7 +7,7 @@ title: VoicemailOrganizationPolicy
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
- | **enabled** | **BOOLEAN** | | [optional] [default to false]|
10
+ | **enabled** | **BOOLEAN** | | [optional] |
11
11
  | **retention_time_days** | **Integer** | | [optional] |
12
12
  | **alert_timeout_seconds** | **Integer** | | [optional] |
13
13
  | **minimum_recording_time_seconds** | **Integer** | | [optional] |
@@ -15,14 +15,14 @@ title: VoicemailOrganizationPolicy
15
15
  | **unavailable_message_uri** | **String** | | [optional] |
16
16
  | **name_prompt_message_uri** | **String** | | [optional] |
17
17
  | **full_message_uri** | **String** | | [optional] |
18
- | **compress_silence** | **BOOLEAN** | | [optional] [default to false]|
18
+ | **compress_silence** | **BOOLEAN** | | [optional] |
19
19
  | **pin_configuration** | [**PINConfiguration**](PINConfiguration.html) | | [optional] |
20
20
  | **quota_size_bytes** | **Integer** | | [optional] |
21
21
  | **created_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
22
22
  | **modified_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
23
23
  | **voicemail_extension** | **String** | The extension for voicemail retrieval. The default value is *86. | [optional] |
24
- | **pin_required** | **BOOLEAN** | If this is true, a PIN is required when accessing a user&#39;s voicemail from a phone. | [optional] [default to false]|
25
- | **send_email_notifications** | **BOOLEAN** | Whether email notifications are sent for new voicemails in the organization. If false, new voicemail email notifications are not be sent for the organization overriding any user or group setting. | [optional] [default to false]|
24
+ | **pin_required** | **BOOLEAN** | If this is true, a PIN is required when accessing a user&#39;s voicemail from a phone. | [optional] |
25
+ | **send_email_notifications** | **BOOLEAN** | Whether email notifications are sent for new voicemails in the organization. If false, new voicemail email notifications are not be sent for the organization overriding any user or group setting. | [optional] |
26
26
  {: class="table table-striped"}
27
27
 
28
28
 
@@ -7,7 +7,7 @@ title: VoicemailUserPolicy
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
- | **enabled** | **BOOLEAN** | | [optional] [default to false]|
10
+ | **enabled** | **BOOLEAN** | | [optional] |
11
11
  | **alert_timeout_seconds** | **Integer** | | [optional] |
12
12
  | **minimum_recording_time_seconds** | **Integer** | | [optional] |
13
13
  | **maximum_recording_time_seconds** | **Integer** | | [optional] |
@@ -17,6 +17,7 @@ Method | HTTP request | Description
17
17
  |[**patch_timeoffrequests_timeoffrequest_id**](WorkforceManagementApi.html#patch_timeoffrequests_timeoffrequest_id) | **PATCH** /api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId} | Mark a time off request for the current user as read or unread|
18
18
  |[**post_decisions_downloads_search**](WorkforceManagementApi.html#post_decisions_downloads_search) | **POST** /api/v2/workforcemanagement/decisions/downloads/search | Download decisions files metadata|
19
19
  |[**post_longtermforecasts**](WorkforceManagementApi.html#post_longtermforecasts) | **POST** /api/v2/workforcemanagement/longtermforecasts | Create a forecast|
20
+ |[**post_schedules**](WorkforceManagementApi.html#post_schedules) | **POST** /api/v2/workforcemanagement/schedules | Get a schedule for the current user|
20
21
  {: class="table table-striped"}
21
22
 
22
23
  <a name="get_adherence"></a>
@@ -544,3 +545,60 @@ Name | Type | Description | Notes
544
545
 
545
546
 
546
547
 
548
+ <a name="post_schedules"></a>
549
+
550
+ ## -[**TimeOffRequestList**](TimeOffRequestList.html) post_schedules(opts)
551
+
552
+ Get a schedule for the current user
553
+
554
+
555
+
556
+ ### Example
557
+ ~~~ruby
558
+ # load the gem
559
+ require 'purecloud'
560
+ # setup authorization
561
+ @secret = ENV['PURECLOUD_SECRET']
562
+ @id = ENV['PURECLOUD_CLIENT_ID']
563
+ environment = "mypurecloud.com"
564
+
565
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
566
+
567
+ PureCloud.configure do |config|
568
+ config.access_token = @authToken
569
+ end
570
+
571
+ api_instance = PureCloud::WorkforceManagementApi.new
572
+
573
+ opts = {
574
+ body: PureCloud::CurrentUserScheduleRequestBody.new # CurrentUserScheduleRequestBody | body
575
+ }
576
+
577
+ begin
578
+ #Get a schedule for the current user
579
+ result = api_instance.post_schedules(opts)
580
+ p result
581
+ rescue PureCloud::ApiError => e
582
+ puts "Exception when calling WorkforceManagementApi->post_schedules: #{e}"
583
+ end
584
+ ~~~
585
+
586
+ ### Parameters
587
+
588
+ Name | Type | Description | Notes
589
+ ------------- | ------------- | ------------- | -------------
590
+ **body** | [**CurrentUserScheduleRequestBody**](CurrentUserScheduleRequestBody.html)| body | [optional]
591
+ {: class="table table-striped"}
592
+
593
+
594
+ ### Return type
595
+
596
+ [**TimeOffRequestList**](TimeOffRequestList.html)
597
+
598
+ ### HTTP request headers
599
+
600
+ - **Content-Type**: application/json
601
+ - **Accept**: application/json
602
+
603
+
604
+