purecloud 0.50.1 → 0.51.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.
- checksums.yaml +4 -4
- data/README.md +6 -6
- data/bin/notificationMappings.json +96 -0
- data/config-ruby.json +1 -1
- data/doc_out/AcwSettings.html.md +2 -2
- data/doc_out/Address.html.md +17 -0
- data/doc_out/Agent.html.md +1 -1
- data/doc_out/AgentActivityEntityListing.html.md +2 -2
- data/doc_out/AlertingApi.html.md +445 -0
- data/doc_out/AttemptLimits.html.md +22 -0
- data/doc_out/AttemptLimitsEntityListing.html.md +22 -0
- data/doc_out/Attribute.html.md +1 -1
- data/doc_out/AttributeEntityListing.html.md +2 -2
- data/doc_out/AuditEntity.html.md +4 -4
- data/doc_out/AuditFacet.html.md +2 -2
- data/doc_out/AuditFilter.html.md +4 -4
- data/doc_out/AuditMessage.html.md +14 -14
- data/doc_out/AuditSearchResult.html.md +4 -4
- data/doc_out/AuditUser.html.md +3 -3
- data/doc_out/AuthorizationApi.html.md +2 -2
- data/doc_out/AvailableTopicEntityListing.html.md +2 -2
- data/doc_out/CalibrationCreate.html.md +28 -0
- data/doc_out/CalibrationEntityListing.html.md +2 -2
- data/doc_out/Call.html.md +17 -17
- data/doc_out/CallCommand.html.md +1 -1
- data/doc_out/CallConversationEntityListing.html.md +2 -2
- data/doc_out/CallConversationNotification.html.md +17 -0
- data/doc_out/CallConversationNotificationCallMediaParticipant.html.md +44 -0
- data/doc_out/CallConversationNotificationDetail.html.md +16 -0
- data/doc_out/CallConversationNotificationErrorBody.html.md +22 -0
- data/doc_out/CallConversationNotificationErrorInfo.html.md +22 -0
- data/doc_out/CallConversationNotificationFaxStatus.html.md +20 -0
- data/doc_out/CallConversationNotificationParticipants.html.md +44 -0
- data/doc_out/CallConversationNotificationUriReference.html.md +14 -0
- data/doc_out/CallMediaParticipant.html.md +6 -3
- data/doc_out/CallableTimeSetEntityListing.html.md +2 -2
- data/doc_out/Callback.html.md +16 -16
- data/doc_out/CallbackConversationEntityListing.html.md +2 -2
- data/doc_out/CallbackConversationNotification.html.md +16 -0
- data/doc_out/CallbackConversationNotificationCallbackMediaParticipant.html.md +39 -0
- data/doc_out/CallbackConversationNotificationDetail.html.md +16 -0
- data/doc_out/CallbackConversationNotificationDialerPreview.html.md +18 -0
- data/doc_out/CallbackConversationNotificationErrorBody.html.md +22 -0
- data/doc_out/CallbackConversationNotificationErrorInfo.html.md +22 -0
- data/doc_out/CallbackConversationNotificationErrorInfoDetails.html.md +16 -0
- data/doc_out/CallbackConversationNotificationParticipants.html.md +39 -0
- data/doc_out/CallbackConversationNotificationPhoneNumberColumn.html.md +15 -0
- data/doc_out/CallbackConversationNotificationUriReference.html.md +14 -0
- data/doc_out/CallbackConversationNotificationUser.html.md +14 -0
- data/doc_out/CallbackMediaParticipant.html.md +6 -3
- data/doc_out/Campaign.html.md +1 -0
- data/doc_out/CampaignEntityListing.html.md +2 -2
- data/doc_out/CampaignInteraction.html.md +33 -0
- data/doc_out/CampaignInteractions.html.md +17 -0
- data/doc_out/CampaignSequenceEntityListing.html.md +2 -2
- data/doc_out/CertificateAuthorityEntityListing.html.md +2 -2
- data/doc_out/Change.html.md +3 -3
- data/doc_out/ChannelEntityListing.html.md +2 -2
- data/doc_out/ChannelTopicEntityListing.html.md +2 -2
- data/doc_out/ChatConversationEntityListing.html.md +2 -2
- data/doc_out/ChatConversationNotification.html.md +16 -0
- data/doc_out/ChatConversationNotificationChatMediaParticipant.html.md +34 -0
- data/doc_out/ChatConversationNotificationDetail.html.md +16 -0
- data/doc_out/ChatConversationNotificationErrorBody.html.md +22 -0
- data/doc_out/ChatConversationNotificationErrorInfo.html.md +22 -0
- data/doc_out/ChatConversationNotificationParticipants.html.md +34 -0
- data/doc_out/ChatConversationNotificationUriReference.html.md +14 -0
- data/doc_out/ChatMediaParticipant.html.md +6 -3
- data/doc_out/CobrowseConversation.html.md +17 -0
- data/doc_out/CobrowseConversationEntityListing.html.md +22 -0
- data/doc_out/CobrowseConversationNotification.html.md +16 -0
- data/doc_out/CobrowseConversationNotificationCobrowseMediaParticipant.html.md +38 -0
- data/doc_out/CobrowseConversationNotificationDetail.html.md +16 -0
- data/doc_out/CobrowseConversationNotificationErrorBody.html.md +22 -0
- data/doc_out/CobrowseConversationNotificationErrorInfo.html.md +22 -0
- data/doc_out/CobrowseConversationNotificationParticipants.html.md +38 -0
- data/doc_out/CobrowseConversationNotificationUriReference.html.md +14 -0
- data/doc_out/CobrowseMediaParticipant.html.md +41 -0
- data/doc_out/Cobrowsesession.html.md +23 -0
- data/doc_out/CommandStatusEntityListing.html.md +2 -2
- data/doc_out/ContactListEntityListing.html.md +2 -2
- data/doc_out/ContactSort.html.md +1 -1
- data/doc_out/ContentManagementApi.html.md +34 -33
- data/doc_out/ConversationChat.html.md +12 -11
- data/doc_out/ConversationEntityListing.html.md +2 -2
- data/doc_out/ConversationNotification.html.md +17 -0
- data/doc_out/ConversationNotificationAddress.html.md +18 -0
- data/doc_out/ConversationNotificationCall.html.md +31 -0
- data/doc_out/ConversationNotificationCallback.html.md +28 -0
- data/doc_out/ConversationNotificationCallbacks.html.md +28 -0
- data/doc_out/ConversationNotificationCalls.html.md +31 -0
- data/doc_out/ConversationNotificationChat.html.md +21 -0
- data/doc_out/ConversationNotificationChats.html.md +21 -0
- data/doc_out/ConversationNotificationCobrowse.html.md +25 -0
- data/doc_out/ConversationNotificationCobrowsesessions.html.md +25 -0
- data/doc_out/ConversationNotificationDialerPreview.html.md +18 -0
- data/doc_out/ConversationNotificationDialerPreviewPhoneNumberColumns.html.md +15 -0
- data/doc_out/ConversationNotificationDisconnectReason.html.md +15 -0
- data/doc_out/ConversationNotificationDisconnectReasons.html.md +15 -0
- data/doc_out/ConversationNotificationEmail.html.md +23 -0
- data/doc_out/ConversationNotificationEmails.html.md +23 -0
- data/doc_out/ConversationNotificationErrorDetails.html.md +20 -0
- data/doc_out/ConversationNotificationErrorInfo.html.md +20 -0
- data/doc_out/ConversationNotificationFaxStatus.html.md +20 -0
- data/doc_out/ConversationNotificationParticipant.html.md +39 -0
- data/doc_out/ConversationNotificationParticipants.html.md +39 -0
- data/doc_out/ConversationNotificationPhoneNumberColumn.html.md +15 -0
- data/doc_out/ConversationNotificationScreenShare.html.md +21 -0
- data/doc_out/ConversationNotificationScreenShares.html.md +21 -0
- data/doc_out/ConversationNotificationSelf.html.md +18 -0
- data/doc_out/ConversationNotificationSocialExpression.html.md +25 -0
- data/doc_out/ConversationNotificationSocialExpressions.html.md +25 -0
- data/doc_out/ConversationNotificationVideo.html.md +24 -0
- data/doc_out/ConversationNotificationVideos.html.md +24 -0
- data/doc_out/ConversationNotificationWrapup.html.md +18 -0
- data/doc_out/ConversationsApi.html.md +707 -161
- data/doc_out/CreateCallbackCommand.html.md +1 -1
- data/doc_out/CreateShareRequest.html.md +3 -3
- data/doc_out/DIDEntityListing.html.md +2 -2
- data/doc_out/DIDPoolEntityListing.html.md +2 -2
- data/doc_out/DialerAuditRequest.html.md +4 -4
- data/doc_out/DialerContact.html.md +1 -1
- data/doc_out/DialerPreview.html.md +4 -4
- data/doc_out/DisconnectReason.html.md +3 -3
- data/doc_out/DncList.html.md +1 -2
- data/doc_out/DncListEntityListing.html.md +2 -2
- data/doc_out/DocumentAuditEntityListing.html.md +2 -2
- data/doc_out/DocumentEntityListing.html.md +2 -2
- data/doc_out/DocumentUpdate.html.md +1 -1
- data/doc_out/DocumentUpload.html.md +2 -2
- data/doc_out/DomainCapabilities.html.md +5 -3
- data/doc_out/DomainEdgeSoftwareVersionDto.html.md +1 -1
- data/doc_out/DomainEdgeSoftwareVersionDtoEntityListing.html.md +22 -0
- data/doc_out/DomainEntityListing.html.md +2 -2
- data/doc_out/DomainEntityListingEvaluationForm.html.md +2 -2
- data/doc_out/DomainEntityListingQueryResult.html.md +2 -2
- data/doc_out/DomainLogicalInterface.html.md +5 -8
- data/doc_out/DomainNetworkAddress.html.md +4 -4
- data/doc_out/DomainNetworkRoute.html.md +5 -5
- data/doc_out/DomainOrganizationRoleCreate.html.md +22 -0
- data/doc_out/Edge.html.md +2 -1
- data/doc_out/EdgeEntityListing.html.md +2 -2
- data/doc_out/EdgeGroupEntityListing.html.md +2 -2
- data/doc_out/EdgeLineEntityListing.html.md +2 -2
- data/doc_out/EdgeLogsJobRequest.html.md +3 -3
- data/doc_out/EdgeLogsJobUploadRequest.html.md +1 -1
- data/doc_out/EdgeOfflineConfiguration.html.md +14 -0
- data/doc_out/EdgeOfflineConfigurationInterface.html.md +16 -0
- data/doc_out/EdgeOfflineConfigurationNetwork.html.md +13 -0
- data/doc_out/EdgeOfflineConfigurationResponse.html.md +13 -0
- data/doc_out/Email.html.md +13 -12
- data/doc_out/EmailConversationEntityListing.html.md +2 -2
- data/doc_out/EmailConversationNotification.html.md +16 -0
- data/doc_out/EmailConversationNotificationDetail.html.md +16 -0
- data/doc_out/EmailConversationNotificationEmailMediaParticipant.html.md +35 -0
- data/doc_out/EmailConversationNotificationErrorBody.html.md +22 -0
- data/doc_out/EmailConversationNotificationErrorInfo.html.md +22 -0
- data/doc_out/EmailConversationNotificationParticipants.html.md +35 -0
- data/doc_out/EmailConversationNotificationUriReference.html.md +14 -0
- data/doc_out/EmailMediaParticipant.html.md +6 -3
- data/doc_out/EmailMessage.html.md +3 -3
- data/doc_out/EmailMessageListing.html.md +2 -2
- data/doc_out/EncryptionKeyEntityListing.html.md +2 -2
- data/doc_out/EndpointEntityListing.html.md +2 -2
- data/doc_out/Entry.html.md +2 -2
- data/doc_out/EvaluationEntityListing.html.md +2 -2
- data/doc_out/EvaluationForm.html.md +3 -3
- data/doc_out/EvaluationFormEntityListing.html.md +2 -2
- data/doc_out/EvaluatorActivityEntityListing.html.md +2 -2
- data/doc_out/ExtensionEntityListing.html.md +2 -2
- data/doc_out/ExtensionPoolEntityListing.html.md +2 -2
- data/doc_out/FacetInfo.html.md +2 -2
- data/doc_out/FaxDocumentEntityListing.html.md +2 -2
- data/doc_out/FaxStatus.html.md +8 -8
- data/doc_out/Group.html.md +1 -1
- data/doc_out/GroupEntityListing.html.md +2 -2
- data/doc_out/GroupMembersUpdate.html.md +2 -2
- data/doc_out/GroupUpdate.html.md +22 -0
- data/doc_out/GroupsApi.html.md +122 -4
- data/doc_out/HeartBeatAlert.html.md +24 -0
- data/doc_out/HeartBeatAlertContainer.html.md +22 -0
- data/doc_out/HeartBeatAlertNotification.html.md +22 -0
- data/doc_out/HeartBeatAlertNotificationNotificationUser.html.md +14 -0
- data/doc_out/HeartBeatAlertNotificationNotificationUsers.html.md +14 -0
- data/doc_out/HeartBeatRule.html.md +22 -0
- data/doc_out/HeartBeatRuleContainer.html.md +22 -0
- data/doc_out/HeartBeatRuleNotification.html.md +21 -0
- data/doc_out/HeartBeatRuleNotificationNotificationUser.html.md +14 -0
- data/doc_out/InboundDomainEntityListing.html.md +2 -2
- data/doc_out/InboundRoute.html.md +3 -3
- data/doc_out/InboundRouteEntityListing.html.md +2 -2
- data/doc_out/InteractionStatAlertNotification.html.md +28 -0
- data/doc_out/InteractionStatAlertNotificationNotificationUser.html.md +14 -0
- data/doc_out/InteractionStatRuleNotification.html.md +26 -0
- data/doc_out/InteractionStatRuleNotificationNotificationUser.html.md +14 -0
- data/doc_out/InteractionStatsAlertContainer.html.md +2 -2
- data/doc_out/InteractionStatsRuleContainer.html.md +2 -2
- data/doc_out/JsonNode.html.md +2 -2
- data/doc_out/Keyword.html.md +4 -1
- data/doc_out/KeywordSet.html.md +1 -1
- data/doc_out/KeywordSetEntityListing.html.md +2 -2
- data/doc_out/Language.html.md +1 -1
- data/doc_out/LanguageEntityListing.html.md +2 -2
- data/doc_out/Library.html.md +1 -1
- data/doc_out/LibraryEntityListing.html.md +2 -2
- data/doc_out/LineBaseEntityListing.html.md +2 -2
- data/doc_out/LineEntityListing.html.md +2 -2
- data/doc_out/LocationsApi.html.md +4 -4
- data/doc_out/LogicalInterfaceEntityListing.html.md +2 -2
- data/doc_out/MaxParticipants.html.md +1 -1
- data/doc_out/MetaData.html.md +15 -0
- data/doc_out/OAuthClientEntityListing.html.md +2 -2
- data/doc_out/OAuthProviderEntityListing.html.md +2 -2
- data/doc_out/OrganizationPresence.html.md +1 -1
- data/doc_out/OrganizationPresenceEntityListing.html.md +2 -2
- data/doc_out/OrganizationRoleEntityListing.html.md +2 -2
- data/doc_out/OrphanRecordingListing.html.md +2 -2
- data/doc_out/OutOfOfficeNotification.html.md +17 -0
- data/doc_out/OutOfOfficeNotificationUser.html.md +13 -0
- data/doc_out/OutboundApi.html.md +356 -0
- data/doc_out/OutboundRouteEntityListing.html.md +2 -2
- data/doc_out/Participant.html.md +28 -25
- data/doc_out/ParticipantAttributes.html.md +1 -1
- data/doc_out/PermissionCollectionEntityListing.html.md +2 -2
- data/doc_out/PhoneBaseEntityListing.html.md +2 -2
- data/doc_out/PhoneEntityListing.html.md +2 -2
- data/doc_out/PhoneMetaBaseEntityListing.html.md +2 -2
- data/doc_out/PhonesReboot.html.md +2 -2
- data/doc_out/PhysicalInterfaceEntityListing.html.md +2 -2
- data/doc_out/PolicyCreate.html.md +24 -0
- data/doc_out/PolicyEntityListing.html.md +2 -2
- data/doc_out/PresenceApi.html.md +10 -4
- data/doc_out/QualityApi.html.md +16 -16
- data/doc_out/QualityAudit.html.md +1 -1
- data/doc_out/QualityAuditPage.html.md +2 -2
- data/doc_out/QueueEntityListing.html.md +2 -2
- data/doc_out/QueueMemberEntityListing.html.md +22 -0
- data/doc_out/RecordingApi.html.md +63 -3
- data/doc_out/ReportMetaDataEntityListing.html.md +2 -2
- data/doc_out/ReportRunEntryEntityDomainListing.html.md +2 -2
- data/doc_out/ReportScheduleEntityListing.html.md +2 -2
- data/doc_out/ResponseEntityList.html.md +2 -2
- data/doc_out/ResponseEntityListing.html.md +2 -2
- data/doc_out/ResponseSetEntityListing.html.md +2 -2
- data/doc_out/RoutingApi.html.md +93 -24
- data/doc_out/RoutingSkill.html.md +1 -1
- data/doc_out/RoutingStatus.html.md +3 -3
- data/doc_out/RuleSetEntityListing.html.md +2 -2
- data/doc_out/SchemaCategoryEntityListing.html.md +2 -2
- data/doc_out/SchemaReferenceEntityListing.html.md +2 -2
- data/doc_out/ScreenRecordingSession.html.md +3 -0
- data/doc_out/ScreenRecordingSessionListing.html.md +5 -0
- data/doc_out/ScreenRecordingSessionRequest.html.md +15 -0
- data/doc_out/ScreenShareConversationNotification.html.md +16 -0
- data/doc_out/ScreenShareConversationNotificationDetail.html.md +16 -0
- data/doc_out/ScreenShareConversationNotificationErrorBody.html.md +22 -0
- data/doc_out/ScreenShareConversationNotificationErrorInfo.html.md +22 -0
- data/doc_out/ScreenShareConversationNotificationParticipants.html.md +36 -0
- data/doc_out/ScreenShareConversationNotificationScreenShareMediaParticipant.html.md +36 -0
- data/doc_out/ScreenShareConversationNotificationUriReference.html.md +14 -0
- data/doc_out/Screenshare.html.md +20 -0
- data/doc_out/SearchApi.html.md +26 -26
- data/doc_out/SecurityProfileEntityListing.html.md +2 -2
- data/doc_out/Segment.html.md +5 -5
- data/doc_out/ServiceContext.html.md +1 -1
- data/doc_out/ShareEntityListing.html.md +2 -2
- data/doc_out/Site.html.md +1 -1
- data/doc_out/SiteEntityListing.html.md +2 -2
- data/doc_out/SkillEntityListing.html.md +2 -2
- data/doc_out/SocialConversationNotification.html.md +16 -0
- data/doc_out/SocialConversationNotificationDetail.html.md +16 -0
- data/doc_out/SocialConversationNotificationErrorBody.html.md +22 -0
- data/doc_out/SocialConversationNotificationErrorInfo.html.md +22 -0
- data/doc_out/SocialConversationNotificationParticipants.html.md +37 -0
- data/doc_out/SocialConversationNotificationSocialMediaParticipant.html.md +37 -0
- data/doc_out/SocialConversationNotificationUriReference.html.md +14 -0
- data/doc_out/SocialExpression.html.md +13 -13
- data/doc_out/StationEntityListing.html.md +2 -2
- data/doc_out/StreetAddress.html.md +1 -1
- data/doc_out/SubscriberResponse.html.md +2 -2
- data/doc_out/SuggestApi.html.md +14 -14
- data/doc_out/TagValue.html.md +1 -1
- data/doc_out/TagValueEntityListing.html.md +2 -2
- data/doc_out/TelephonyProvidersEdgeApi.html.md +121 -7
- data/doc_out/TimeZoneEntityListing.html.md +2 -2
- data/doc_out/TrunkEntityListing.html.md +2 -2
- data/doc_out/TrunkMetabaseEntityListing.html.md +2 -2
- data/doc_out/UserConversationSummaryNotification.html.md +19 -0
- data/doc_out/UserConversationSummaryNotificationCall.html.md +14 -0
- data/doc_out/UserConversationSummaryNotificationCallContactCenter.html.md +14 -0
- data/doc_out/UserConversationSummaryNotificationMediaSummary.html.md +14 -0
- data/doc_out/UserConversationSummaryNotificationMediaSummaryDetail.html.md +14 -0
- data/doc_out/UserEntityListing.html.md +2 -2
- data/doc_out/UserMe.html.md +1 -0
- data/doc_out/UserPresenceNotification.html.md +16 -0
- data/doc_out/UserPresenceNotificationOrganizationPresence.html.md +14 -0
- data/doc_out/UserPresenceNotificationPresenceDefinition.html.md +14 -0
- data/doc_out/UserQueueEntityListing.html.md +2 -2
- data/doc_out/UserRecordingEntityListing.html.md +2 -2
- data/doc_out/UserRecordingsApi.html.md +6 -6
- data/doc_out/UserRoutingSkillPost.html.md +16 -0
- data/doc_out/UserSkillEntityListing.html.md +2 -2
- data/doc_out/UsersApi.html.md +14 -14
- data/doc_out/UsersEntityListing.html.md +2 -2
- data/doc_out/ValidateAddressRequest.html.md +1 -1
- data/doc_out/ValidateAddressResponse.html.md +2 -2
- data/doc_out/Video.html.md +10 -10
- data/doc_out/VideoConversationNotification.html.md +16 -0
- data/doc_out/VideoConversationNotificationDetail.html.md +16 -0
- data/doc_out/VideoConversationNotificationErrorBody.html.md +22 -0
- data/doc_out/VideoConversationNotificationErrorInfo.html.md +22 -0
- data/doc_out/VideoConversationNotificationParticipants.html.md +39 -0
- data/doc_out/VideoConversationNotificationUriReference.html.md +14 -0
- data/doc_out/VideoConversationNotificationVideoMediaParticipant.html.md +39 -0
- data/doc_out/VmPairingInfo.html.md +16 -0
- data/doc_out/WorkspaceCreate.html.md +1 -1
- data/doc_out/WorkspaceEntityListing.html.md +2 -2
- data/doc_out/WorkspaceMemberEntityListing.html.md +2 -2
- data/doc_out/Wrapup.html.md +7 -7
- data/doc_out/WrapupCode.html.md +1 -1
- data/doc_out/WrapupCodeEntityListing.html.md +2 -2
- data/doc_out/index.html.md +6 -6
- data/lib/purecloud.rb +138 -0
- data/lib/purecloud/api/alerting_api.rb +473 -0
- data/lib/purecloud/api/content_management_api.rb +49 -100
- data/lib/purecloud/api/conversations_api.rb +749 -164
- data/lib/purecloud/api/groups_api.rb +126 -4
- data/lib/purecloud/api/locations_api.rb +4 -4
- data/lib/purecloud/api/outbound_api.rb +386 -0
- data/lib/purecloud/api/presence_api.rb +8 -2
- data/lib/purecloud/api/quality_api.rb +14 -14
- data/lib/purecloud/api/recording_api.rb +63 -2
- data/lib/purecloud/api/routing_api.rb +108 -30
- data/lib/purecloud/api/search_api.rb +26 -26
- data/lib/purecloud/api/suggest_api.rb +14 -14
- data/lib/purecloud/api/telephony_providers_edge_api.rb +128 -8
- data/lib/purecloud/api/user_recordings_api.rb +9 -9
- data/lib/purecloud/api/users_api.rb +12 -12
- data/lib/purecloud/api_client.rb +1 -1
- data/lib/purecloud/models/acw_settings.rb +2 -0
- data/lib/purecloud/models/address.rb +210 -0
- data/lib/purecloud/models/agent.rb +1 -0
- data/lib/purecloud/models/agent_activity_entity_listing.rb +13 -13
- data/lib/purecloud/models/analytics_session.rb +1 -1
- data/lib/purecloud/models/attempt_limits.rb +271 -0
- data/lib/purecloud/models/attempt_limits_entity_listing.rb +257 -0
- data/lib/purecloud/models/attribute.rb +1 -0
- data/lib/purecloud/models/attribute_entity_listing.rb +13 -13
- data/lib/purecloud/models/audit_entity.rb +4 -0
- data/lib/purecloud/models/audit_facet.rb +2 -0
- data/lib/purecloud/models/audit_filter.rb +4 -0
- data/lib/purecloud/models/audit_message.rb +14 -0
- data/lib/purecloud/models/audit_search_result.rb +4 -0
- data/lib/purecloud/models/audit_user.rb +3 -0
- data/lib/purecloud/models/available_topic_entity_listing.rb +13 -13
- data/lib/purecloud/models/calibration_create.rb +323 -0
- data/lib/purecloud/models/calibration_entity_listing.rb +13 -13
- data/lib/purecloud/models/call.rb +18 -4
- data/lib/purecloud/models/call_command.rb +1 -0
- data/lib/purecloud/models/call_conversation_entity_listing.rb +13 -13
- data/lib/purecloud/models/call_conversation_notification.rb +218 -0
- data/lib/purecloud/models/call_conversation_notification_call_media_participant.rb +513 -0
- data/lib/purecloud/models/call_conversation_notification_detail.rb +195 -0
- data/lib/purecloud/models/call_conversation_notification_error_body.rb +261 -0
- data/lib/purecloud/models/call_conversation_notification_error_info.rb +261 -0
- data/lib/purecloud/models/call_conversation_notification_fax_status.rb +235 -0
- data/lib/purecloud/models/call_conversation_notification_participants.rb +513 -0
- data/lib/purecloud/models/call_conversation_notification_uri_reference.rb +175 -0
- data/lib/purecloud/models/call_media_participant.rb +38 -5
- data/lib/purecloud/models/callable_time_set_entity_listing.rb +13 -13
- data/lib/purecloud/models/callback.rb +17 -5
- data/lib/purecloud/models/callback_conversation_entity_listing.rb +13 -13
- data/lib/purecloud/models/callback_conversation_notification.rb +199 -0
- data/lib/purecloud/models/callback_conversation_notification_callback_media_participant.rb +456 -0
- data/lib/purecloud/models/callback_conversation_notification_detail.rb +195 -0
- data/lib/purecloud/models/callback_conversation_notification_dialer_preview.rb +217 -0
- data/lib/purecloud/models/callback_conversation_notification_error_body.rb +261 -0
- data/lib/purecloud/models/callback_conversation_notification_error_info.rb +261 -0
- data/lib/purecloud/models/callback_conversation_notification_error_info_details.rb +195 -0
- data/lib/purecloud/models/callback_conversation_notification_participants.rb +456 -0
- data/lib/purecloud/models/callback_conversation_notification_phone_number_column.rb +185 -0
- data/lib/purecloud/models/callback_conversation_notification_uri_reference.rb +175 -0
- data/lib/purecloud/models/callback_conversation_notification_user.rb +175 -0
- data/lib/purecloud/models/callback_media_participant.rb +38 -5
- data/lib/purecloud/models/campaign.rb +12 -1
- data/lib/purecloud/models/campaign_entity_listing.rb +13 -13
- data/lib/purecloud/models/campaign_interaction.rb +388 -0
- data/lib/purecloud/models/campaign_interactions.rb +213 -0
- data/lib/purecloud/models/campaign_sequence_entity_listing.rb +13 -13
- data/lib/purecloud/models/certificate_authority_entity_listing.rb +13 -13
- data/lib/purecloud/models/change.rb +3 -0
- data/lib/purecloud/models/channel_entity_listing.rb +13 -13
- data/lib/purecloud/models/channel_topic_entity_listing.rb +13 -13
- data/lib/purecloud/models/chat_conversation_entity_listing.rb +13 -13
- data/lib/purecloud/models/chat_conversation_notification.rb +199 -0
- data/lib/purecloud/models/chat_conversation_notification_chat_media_participant.rb +404 -0
- data/lib/purecloud/models/chat_conversation_notification_detail.rb +195 -0
- data/lib/purecloud/models/chat_conversation_notification_error_body.rb +261 -0
- data/lib/purecloud/models/chat_conversation_notification_error_info.rb +261 -0
- data/lib/purecloud/models/chat_conversation_notification_participants.rb +404 -0
- data/lib/purecloud/models/chat_conversation_notification_uri_reference.rb +175 -0
- data/lib/purecloud/models/chat_media_participant.rb +38 -5
- data/lib/purecloud/models/cobrowse_conversation.rb +213 -0
- data/lib/purecloud/models/cobrowse_conversation_entity_listing.rb +257 -0
- data/lib/purecloud/models/cobrowse_conversation_notification.rb +199 -0
- data/lib/purecloud/models/cobrowse_conversation_notification_cobrowse_media_participant.rb +446 -0
- data/lib/purecloud/models/cobrowse_conversation_notification_detail.rb +195 -0
- data/lib/purecloud/models/cobrowse_conversation_notification_error_body.rb +261 -0
- data/lib/purecloud/models/cobrowse_conversation_notification_error_info.rb +261 -0
- data/lib/purecloud/models/cobrowse_conversation_notification_participants.rb +446 -0
- data/lib/purecloud/models/cobrowse_conversation_notification_uri_reference.rb +175 -0
- data/lib/purecloud/models/cobrowse_media_participant.rb +511 -0
- data/lib/purecloud/models/cobrowsesession.rb +296 -0
- data/lib/purecloud/models/command_status_entity_listing.rb +13 -13
- data/lib/purecloud/models/contact_list_entity_listing.rb +13 -13
- data/lib/purecloud/models/contact_sort.rb +1 -0
- data/lib/purecloud/models/conversation_chat.rb +26 -7
- data/lib/purecloud/models/conversation_entity_listing.rb +13 -13
- data/lib/purecloud/models/conversation_notification.rb +207 -0
- data/lib/purecloud/models/conversation_notification_address.rb +215 -0
- data/lib/purecloud/models/conversation_notification_call.rb +383 -0
- data/lib/purecloud/models/conversation_notification_callback.rb +344 -0
- data/lib/purecloud/models/conversation_notification_callbacks.rb +344 -0
- data/lib/purecloud/models/conversation_notification_calls.rb +383 -0
- data/lib/purecloud/models/conversation_notification_chat.rb +263 -0
- data/lib/purecloud/models/conversation_notification_chats.rb +263 -0
- data/lib/purecloud/models/conversation_notification_cobrowse.rb +305 -0
- data/lib/purecloud/models/conversation_notification_cobrowsesessions.rb +305 -0
- data/lib/purecloud/models/conversation_notification_dialer_preview.rb +217 -0
- data/lib/purecloud/models/conversation_notification_dialer_preview_phone_number_columns.rb +185 -0
- data/lib/purecloud/models/conversation_notification_disconnect_reason.rb +194 -0
- data/lib/purecloud/models/conversation_notification_disconnect_reasons.rb +194 -0
- data/lib/purecloud/models/conversation_notification_email.rb +283 -0
- data/lib/purecloud/models/conversation_notification_emails.rb +283 -0
- data/lib/purecloud/models/conversation_notification_error_details.rb +237 -0
- data/lib/purecloud/models/conversation_notification_error_info.rb +237 -0
- data/lib/purecloud/models/conversation_notification_fax_status.rb +235 -0
- data/lib/purecloud/models/conversation_notification_participant.rb +443 -0
- data/lib/purecloud/models/conversation_notification_participants.rb +443 -0
- data/lib/purecloud/models/conversation_notification_phone_number_column.rb +185 -0
- data/lib/purecloud/models/conversation_notification_screen_share.rb +263 -0
- data/lib/purecloud/models/conversation_notification_screen_shares.rb +263 -0
- data/lib/purecloud/models/conversation_notification_self.rb +215 -0
- data/lib/purecloud/models/conversation_notification_social_expression.rb +303 -0
- data/lib/purecloud/models/conversation_notification_social_expressions.rb +303 -0
- data/lib/purecloud/models/conversation_notification_video.rb +302 -0
- data/lib/purecloud/models/conversation_notification_videos.rb +302 -0
- data/lib/purecloud/models/conversation_notification_wrapup.rb +217 -0
- data/lib/purecloud/models/create_callback_command.rb +1 -1
- data/lib/purecloud/models/create_share_request.rb +3 -0
- data/lib/purecloud/models/dialer_audit_request.rb +4 -0
- data/lib/purecloud/models/dialer_contact.rb +1 -1
- data/lib/purecloud/models/dialer_preview.rb +4 -0
- data/lib/purecloud/models/did_entity_listing.rb +13 -13
- data/lib/purecloud/models/did_pool_entity_listing.rb +13 -13
- data/lib/purecloud/models/disconnect_reason.rb +3 -0
- data/lib/purecloud/models/dnc_list.rb +2 -14
- data/lib/purecloud/models/dnc_list_entity_listing.rb +13 -13
- data/lib/purecloud/models/document_audit_entity_listing.rb +13 -13
- data/lib/purecloud/models/document_entity_listing.rb +13 -13
- data/lib/purecloud/models/document_update.rb +1 -0
- data/lib/purecloud/models/document_upload.rb +2 -0
- data/lib/purecloud/models/domain_capabilities.rb +33 -4
- data/lib/purecloud/models/domain_edge_software_version_dto.rb +13 -13
- data/lib/purecloud/models/domain_edge_software_version_dto_entity_listing.rb +257 -0
- data/lib/purecloud/models/domain_entity_listing.rb +13 -13
- data/lib/purecloud/models/domain_entity_listing_evaluation_form.rb +13 -13
- data/lib/purecloud/models/domain_entity_listing_query_result.rb +13 -13
- data/lib/purecloud/models/domain_logical_interface.rb +25 -41
- data/lib/purecloud/models/domain_network_address.rb +22 -0
- data/lib/purecloud/models/domain_network_route.rb +14 -0
- data/lib/purecloud/models/domain_organization_role_create.rb +266 -0
- data/lib/purecloud/models/edge.rb +21 -1
- data/lib/purecloud/models/edge_entity_listing.rb +13 -13
- data/lib/purecloud/models/edge_group_entity_listing.rb +13 -13
- data/lib/purecloud/models/edge_line_entity_listing.rb +13 -13
- data/lib/purecloud/models/edge_logs_job_request.rb +3 -0
- data/lib/purecloud/models/edge_logs_job_upload_request.rb +1 -1
- data/lib/purecloud/models/edge_offline_configuration.rb +177 -0
- data/lib/purecloud/models/edge_offline_configuration_interface.rb +203 -0
- data/lib/purecloud/models/edge_offline_configuration_network.rb +166 -0
- data/lib/purecloud/models/edge_offline_configuration_response.rb +166 -0
- data/lib/purecloud/models/email.rb +28 -8
- data/lib/purecloud/models/email_conversation_entity_listing.rb +13 -13
- data/lib/purecloud/models/email_conversation_notification.rb +199 -0
- data/lib/purecloud/models/email_conversation_notification_detail.rb +195 -0
- data/lib/purecloud/models/email_conversation_notification_email_media_participant.rb +414 -0
- data/lib/purecloud/models/email_conversation_notification_error_body.rb +261 -0
- data/lib/purecloud/models/email_conversation_notification_error_info.rb +261 -0
- data/lib/purecloud/models/email_conversation_notification_participants.rb +414 -0
- data/lib/purecloud/models/email_conversation_notification_uri_reference.rb +175 -0
- data/lib/purecloud/models/email_media_participant.rb +38 -5
- data/lib/purecloud/models/email_message_listing.rb +13 -13
- data/lib/purecloud/models/encryption_key_entity_listing.rb +13 -13
- data/lib/purecloud/models/endpoint_entity_listing.rb +13 -13
- data/lib/purecloud/models/entry.rb +2 -0
- data/lib/purecloud/models/evaluation_entity_listing.rb +13 -13
- data/lib/purecloud/models/evaluation_form.rb +3 -0
- data/lib/purecloud/models/evaluation_form_entity_listing.rb +13 -13
- data/lib/purecloud/models/evaluator_activity_entity_listing.rb +13 -13
- data/lib/purecloud/models/extension_entity_listing.rb +13 -13
- data/lib/purecloud/models/extension_pool_entity_listing.rb +13 -13
- data/lib/purecloud/models/facet_info.rb +2 -0
- data/lib/purecloud/models/fax_document_entity_listing.rb +13 -13
- data/lib/purecloud/models/fax_status.rb +8 -0
- data/lib/purecloud/models/group.rb +1 -0
- data/lib/purecloud/models/group_entity_listing.rb +13 -13
- data/lib/purecloud/models/group_members_update.rb +2 -0
- data/lib/purecloud/models/group_update.rb +286 -0
- data/lib/purecloud/models/heart_beat_alert.rb +299 -0
- data/lib/purecloud/models/heart_beat_alert_container.rb +257 -0
- data/lib/purecloud/models/heart_beat_alert_notification.rb +268 -0
- data/lib/purecloud/models/heart_beat_alert_notification_notification_user.rb +175 -0
- data/lib/purecloud/models/heart_beat_alert_notification_notification_users.rb +175 -0
- data/lib/purecloud/models/heart_beat_rule.rb +282 -0
- data/lib/purecloud/models/heart_beat_rule_container.rb +257 -0
- data/lib/purecloud/models/heart_beat_rule_notification.rb +258 -0
- data/lib/purecloud/models/heart_beat_rule_notification_notification_user.rb +175 -0
- data/lib/purecloud/models/inbound_domain_entity_listing.rb +13 -13
- data/lib/purecloud/models/inbound_route_entity_listing.rb +13 -13
- data/lib/purecloud/models/interaction_stat_alert_notification.rb +364 -0
- data/lib/purecloud/models/interaction_stat_alert_notification_notification_user.rb +175 -0
- data/lib/purecloud/models/interaction_stat_rule_notification.rb +344 -0
- data/lib/purecloud/models/interaction_stat_rule_notification_notification_user.rb +175 -0
- data/lib/purecloud/models/interaction_stats_alert_container.rb +13 -13
- data/lib/purecloud/models/interaction_stats_rule_container.rb +13 -13
- data/lib/purecloud/models/json_node.rb +20 -20
- data/lib/purecloud/models/keyword.rb +41 -1
- data/lib/purecloud/models/keyword_set.rb +1 -0
- data/lib/purecloud/models/keyword_set_entity_listing.rb +13 -13
- data/lib/purecloud/models/language.rb +1 -0
- data/lib/purecloud/models/language_entity_listing.rb +13 -13
- data/lib/purecloud/models/library.rb +1 -0
- data/lib/purecloud/models/library_entity_listing.rb +13 -13
- data/lib/purecloud/models/line_base_entity_listing.rb +13 -13
- data/lib/purecloud/models/line_entity_listing.rb +13 -13
- data/lib/purecloud/models/logical_interface_entity_listing.rb +13 -13
- data/lib/purecloud/models/max_participants.rb +1 -0
- data/lib/purecloud/models/meta_data.rb +187 -0
- data/lib/purecloud/models/o_auth_client_entity_listing.rb +13 -13
- data/lib/purecloud/models/o_auth_provider_entity_listing.rb +13 -13
- data/lib/purecloud/models/organization_presence.rb +1 -0
- data/lib/purecloud/models/organization_presence_entity_listing.rb +13 -13
- data/lib/purecloud/models/organization_role_entity_listing.rb +13 -13
- data/lib/purecloud/models/orphan_recording_listing.rb +13 -13
- data/lib/purecloud/models/out_of_office_notification.rb +205 -0
- data/lib/purecloud/models/out_of_office_notification_user.rb +165 -0
- data/lib/purecloud/models/outbound_route_entity_listing.rb +13 -13
- data/lib/purecloud/models/participant.rb +61 -4
- data/lib/purecloud/models/participant_attributes.rb +1 -0
- data/lib/purecloud/models/permission_collection_entity_listing.rb +13 -13
- data/lib/purecloud/models/phone_base_entity_listing.rb +13 -13
- data/lib/purecloud/models/phone_entity_listing.rb +13 -13
- data/lib/purecloud/models/phone_meta_base_entity_listing.rb +13 -13
- data/lib/purecloud/models/phones_reboot.rb +2 -0
- data/lib/purecloud/models/physical_interface_entity_listing.rb +13 -13
- data/lib/purecloud/models/policy_create.rb +285 -0
- data/lib/purecloud/models/policy_entity_listing.rb +13 -13
- data/lib/purecloud/models/quality_audit.rb +11 -11
- data/lib/purecloud/models/quality_audit_page.rb +13 -13
- data/lib/purecloud/models/queue_entity_listing.rb +13 -13
- data/lib/purecloud/models/queue_member_entity_listing.rb +257 -0
- data/lib/purecloud/models/report_meta_data_entity_listing.rb +13 -13
- data/lib/purecloud/models/report_run_entry_entity_domain_listing.rb +13 -13
- data/lib/purecloud/models/report_schedule_entity_listing.rb +13 -13
- data/lib/purecloud/models/response_entity_list.rb +13 -13
- data/lib/purecloud/models/response_entity_listing.rb +13 -13
- data/lib/purecloud/models/response_set_entity_listing.rb +13 -13
- data/lib/purecloud/models/routing_skill.rb +1 -0
- data/lib/purecloud/models/routing_status.rb +3 -1
- data/lib/purecloud/models/rule_set_entity_listing.rb +13 -13
- data/lib/purecloud/models/schema_category_entity_listing.rb +13 -13
- data/lib/purecloud/models/schema_reference_entity_listing.rb +13 -13
- data/lib/purecloud/models/screen_recording_session.rb +36 -4
- data/lib/purecloud/models/screen_recording_session_listing.rb +51 -1
- data/lib/purecloud/models/screen_recording_session_request.rb +197 -0
- data/lib/purecloud/models/screen_share_conversation_notification.rb +199 -0
- data/lib/purecloud/models/screen_share_conversation_notification_detail.rb +195 -0
- data/lib/purecloud/models/screen_share_conversation_notification_error_body.rb +261 -0
- data/lib/purecloud/models/screen_share_conversation_notification_error_info.rb +261 -0
- data/lib/purecloud/models/screen_share_conversation_notification_participants.rb +424 -0
- data/lib/purecloud/models/screen_share_conversation_notification_screen_share_media_participant.rb +424 -0
- data/lib/purecloud/models/screen_share_conversation_notification_uri_reference.rb +175 -0
- data/lib/purecloud/models/screenshare.rb +263 -0
- data/lib/purecloud/models/security_profile_entity_listing.rb +13 -13
- data/lib/purecloud/models/segment.rb +5 -2
- data/lib/purecloud/models/service_context.rb +1 -0
- data/lib/purecloud/models/share_entity_listing.rb +13 -13
- data/lib/purecloud/models/site.rb +1 -1
- data/lib/purecloud/models/site_entity_listing.rb +13 -13
- data/lib/purecloud/models/skill_entity_listing.rb +13 -13
- data/lib/purecloud/models/social_conversation_notification.rb +199 -0
- data/lib/purecloud/models/social_conversation_notification_detail.rb +195 -0
- data/lib/purecloud/models/social_conversation_notification_error_body.rb +261 -0
- data/lib/purecloud/models/social_conversation_notification_error_info.rb +261 -0
- data/lib/purecloud/models/social_conversation_notification_participants.rb +434 -0
- data/lib/purecloud/models/social_conversation_notification_social_media_participant.rb +434 -0
- data/lib/purecloud/models/social_conversation_notification_uri_reference.rb +175 -0
- data/lib/purecloud/models/social_expression.rb +14 -4
- data/lib/purecloud/models/station_entity_listing.rb +13 -13
- data/lib/purecloud/models/street_address.rb +1 -0
- data/lib/purecloud/models/subscriber_response.rb +2 -0
- data/lib/purecloud/models/tag_value.rb +1 -0
- data/lib/purecloud/models/tag_value_entity_listing.rb +13 -13
- data/lib/purecloud/models/time_zone_entity_listing.rb +13 -13
- data/lib/purecloud/models/trunk_entity_listing.rb +13 -13
- data/lib/purecloud/models/trunk_metabase_entity_listing.rb +13 -13
- data/lib/purecloud/models/user_conversation_summary_notification.rb +225 -0
- data/lib/purecloud/models/user_conversation_summary_notification_call.rb +175 -0
- data/lib/purecloud/models/user_conversation_summary_notification_call_contact_center.rb +175 -0
- data/lib/purecloud/models/user_conversation_summary_notification_media_summary.rb +175 -0
- data/lib/purecloud/models/user_conversation_summary_notification_media_summary_detail.rb +175 -0
- data/lib/purecloud/models/user_entity_listing.rb +13 -13
- data/lib/purecloud/models/user_me.rb +14 -1
- data/lib/purecloud/models/user_presence_notification.rb +195 -0
- data/lib/purecloud/models/user_presence_notification_organization_presence.rb +175 -0
- data/lib/purecloud/models/user_presence_notification_presence_definition.rb +175 -0
- data/lib/purecloud/models/user_queue_entity_listing.rb +13 -13
- data/lib/purecloud/models/user_recording_entity_listing.rb +13 -13
- data/lib/purecloud/models/user_routing_skill_post.rb +200 -0
- data/lib/purecloud/models/user_skill_entity_listing.rb +13 -13
- data/lib/purecloud/models/users_entity_listing.rb +13 -13
- data/lib/purecloud/models/validate_address_request.rb +1 -1
- data/lib/purecloud/models/validate_address_response.rb +2 -0
- data/lib/purecloud/models/video.rb +11 -3
- data/lib/purecloud/models/video_conversation_notification.rb +199 -0
- data/lib/purecloud/models/video_conversation_notification_detail.rb +195 -0
- data/lib/purecloud/models/video_conversation_notification_error_body.rb +261 -0
- data/lib/purecloud/models/video_conversation_notification_error_info.rb +261 -0
- data/lib/purecloud/models/video_conversation_notification_participants.rb +463 -0
- data/lib/purecloud/models/video_conversation_notification_uri_reference.rb +175 -0
- data/lib/purecloud/models/video_conversation_notification_video_media_participant.rb +463 -0
- data/lib/purecloud/models/vm_pairing_info.rb +196 -0
- data/lib/purecloud/models/workspace_create.rb +1 -0
- data/lib/purecloud/models/workspace_entity_listing.rb +13 -13
- data/lib/purecloud/models/workspace_member_entity_listing.rb +13 -13
- data/lib/purecloud/models/wrapup.rb +7 -1
- data/lib/purecloud/models/wrapup_code.rb +1 -0
- data/lib/purecloud/models/wrapup_code_entity_listing.rb +13 -13
- data/lib/purecloud/version.rb +1 -1
- data/newVersion.md +1 -1
- data/swagger.json +1 -1
- data/version.json +1 -1
- metadata +279 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 12957fc96a3abb1a2dc6fd0cafeb2ff3de86d4ef
|
4
|
+
data.tar.gz: 618e7c5a9632f5354027e7ea3bf0f94fe1ed0dd7
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 68703f09f13e7ef4b907f1430291186483965ff1de278c42680c40d5ee548c1202612a6a8c42b7f23557860a677f6c15dcfaf76865eae7ee96d3ddde6be1675f
|
7
|
+
data.tar.gz: 8df94e41c96dcd3128584d368db9ce190647ea7eed20a9efc50073cb3cd3d101c79505c4dd90ce77d16016e9422427d33f0e397cd595f3f605609528949d98ff
|
data/README.md
CHANGED
@@ -9,8 +9,8 @@ With the PureCloud Platform API, you can control all aspects of your PureCloud e
|
|
9
9
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
10
10
|
|
11
11
|
- API version: v2
|
12
|
-
- Package version: 0.
|
13
|
-
- Build date: 2016-
|
12
|
+
- Package version: 0.51.1
|
13
|
+
- Build date: 2016-10-06T14:06:47.047Z
|
14
14
|
|
15
15
|
For more information, please visit [https://developer.mypurecloud.com](https://developer.mypurecloud.com)
|
16
16
|
|
@@ -18,7 +18,7 @@ For more information, please visit [https://developer.mypurecloud.com](https://d
|
|
18
18
|
|
19
19
|
### from rubygems.org
|
20
20
|
|
21
|
-
gem 'purecloud', '~> 0.
|
21
|
+
gem 'purecloud', '~> 0.51.1'
|
22
22
|
|
23
23
|
### Install from Git
|
24
24
|
|
@@ -47,10 +47,10 @@ alert_id = "alert_id_example" # String | Alert ID
|
|
47
47
|
|
48
48
|
|
49
49
|
begin
|
50
|
-
#Delete
|
51
|
-
api_instance.
|
50
|
+
#Delete a heart beat alert
|
51
|
+
api_instance.delete_heartbeat_alerts_alert_id(alert_id)
|
52
52
|
rescue PureCloud::ApiError => e
|
53
|
-
puts "Exception when calling AlertingApi->
|
53
|
+
puts "Exception when calling AlertingApi->delete_heartbeat_alerts_alert_id: #{e}"
|
54
54
|
end
|
55
55
|
|
56
56
|
~~~
|
@@ -0,0 +1,96 @@
|
|
1
|
+
{
|
2
|
+
"notifications": [
|
3
|
+
{
|
4
|
+
"topic": "v2.routing.queues.{id}.conversations",
|
5
|
+
"class": "ConversationNotification"
|
6
|
+
},
|
7
|
+
{
|
8
|
+
"topic": "v2.routing.queues.{id}.conversations.callbacks",
|
9
|
+
"class": "CallbackConversationNotification"
|
10
|
+
},
|
11
|
+
{
|
12
|
+
"topic": "v2.routing.queues.{id}.conversations.calls",
|
13
|
+
"class": "CallConversationNotification"
|
14
|
+
},
|
15
|
+
{
|
16
|
+
"topic": "v2.routing.queues.{id}.conversations.chats",
|
17
|
+
"class": "ChatConversationNotification"
|
18
|
+
},
|
19
|
+
{
|
20
|
+
"topic": "v2.routing.queues.{id}.conversations.cobrowseSessions",
|
21
|
+
"class": "CobrowseConversationNotification"
|
22
|
+
},
|
23
|
+
{
|
24
|
+
"topic": "v2.routing.queues.{id}.conversations.emails",
|
25
|
+
"class": "EmailConversationNotification"
|
26
|
+
},
|
27
|
+
{
|
28
|
+
"topic": "v2.routing.queues.{id}.conversations.screenshares",
|
29
|
+
"class": "ScreenShareConversationNotification"
|
30
|
+
},
|
31
|
+
{
|
32
|
+
"topic": "v2.users.{id}.alerting.heartbeat.alerts",
|
33
|
+
"class": "HeartBeatAlertNotification"
|
34
|
+
},
|
35
|
+
{
|
36
|
+
"topic": "v2.users.{id}.alerting.heartbeat.rules",
|
37
|
+
"class": "HeartBeatRuleNotification"
|
38
|
+
},
|
39
|
+
{
|
40
|
+
"topic": "v2.users.{id}.alerting.interactionstats.alerts",
|
41
|
+
"class": "InteractionStatAlertNotification"
|
42
|
+
},
|
43
|
+
{
|
44
|
+
"topic": "v2.users.{id}.alerting.interactionstats.rules",
|
45
|
+
"class": "InteractionStatRuleNotification"
|
46
|
+
},
|
47
|
+
{
|
48
|
+
"topic": "v2.users.{id}.conversations",
|
49
|
+
"class": "ConversationNotification"
|
50
|
+
},
|
51
|
+
{
|
52
|
+
"topic": "v2.users.{id}.conversations.callbacks",
|
53
|
+
"class": "CallbackConversationNotification"
|
54
|
+
},
|
55
|
+
{
|
56
|
+
"topic": "v2.users.{id}.conversations.calls",
|
57
|
+
"class": "CallConversationNotification"
|
58
|
+
},
|
59
|
+
{
|
60
|
+
"topic": "v2.users.{id}.conversations.chats",
|
61
|
+
"class": "ChatConversationNotification"
|
62
|
+
},
|
63
|
+
{
|
64
|
+
"topic": "v2.users.{id}.conversations.cobrowseSessions",
|
65
|
+
"class": "CobrowseConversationNotification"
|
66
|
+
},
|
67
|
+
{
|
68
|
+
"topic": "v2.users.{id}.conversations.emails",
|
69
|
+
"class": "EmailConversationNotification"
|
70
|
+
},
|
71
|
+
{
|
72
|
+
"topic": "v2.users.{id}.conversations.screenshares",
|
73
|
+
"class": "ScreenShareConversationNotification"
|
74
|
+
},
|
75
|
+
{
|
76
|
+
"topic": "v2.users.{id}.conversations.socialexpressions",
|
77
|
+
"class": "SocialConversationNotification"
|
78
|
+
},
|
79
|
+
{
|
80
|
+
"topic": "v2.users.{id}.conversations.videos",
|
81
|
+
"class": "VideoConversationNotification"
|
82
|
+
},
|
83
|
+
{
|
84
|
+
"topic": "v2.users.{id}.conversationsummary",
|
85
|
+
"class": "UserConversationSummaryNotification"
|
86
|
+
},
|
87
|
+
{
|
88
|
+
"topic": "v2.users.{id}.outofoffice",
|
89
|
+
"class": "OutOfOfficeNotification"
|
90
|
+
},
|
91
|
+
{
|
92
|
+
"topic": "v2.users.{id}.presence",
|
93
|
+
"class": "UserPresenceNotification"
|
94
|
+
}
|
95
|
+
]
|
96
|
+
}
|
data/config-ruby.json
CHANGED
@@ -1 +1 @@
|
|
1
|
-
{"gemVersion":"0.
|
1
|
+
{"gemVersion":"0.51.1","gemName":"purecloud","moduleName":"PureCloud","gemLicense":"MIT","gemSummary":"PureCloud Platform API Library","gemDescription":"A Ruby library to interface with the PureCloud Platform API","gemHomepage":"https://developer.mypurecloud.com","gemAuthor":"Kevin Glinski","gemAuthorEmail":"Kevin.Glinski@inin.com","httpUserAgent":"PureCloud SDK/Ruby 0.51.1","gitUserId":"mypurecloud","gitRepoId":"purecloud_api_sdk_ruby"}
|
data/doc_out/AcwSettings.html.md
CHANGED
@@ -7,8 +7,8 @@ title: AcwSettings
|
|
7
7
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **wrapup_prompt** | **String** |
|
11
|
-
| **timeout_ms** | **Integer** | | [optional] |
|
10
|
+
| **wrapup_prompt** | **String** | This field controls how the UI prompts the agent for a wrapup. | [optional] |
|
11
|
+
| **timeout_ms** | **Integer** | The amount of time the agent can stay in ACW (Min: 1 sec, Max: 1 day). Can only be used when ACW is MANDATORY_TIMEOUT or MANDATORY_FORCED_TIMEOUT. | [optional] |
|
12
12
|
{: class="table table-striped"}
|
13
13
|
|
14
14
|
|
@@ -0,0 +1,17 @@
|
|
1
|
+
---
|
2
|
+
title: Address
|
3
|
+
---
|
4
|
+
## PureCloud::Address
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **name** | **String** | This will be nameRaw if present, or a locality lookup of the address field otherwise. | [optional] |
|
11
|
+
| **name_raw** | **String** | The name as close to the bits on the wire as possible. | [optional] |
|
12
|
+
| **address_normalized** | **String** | The normalized address. This field is acquired from the Address Normalization Table. The addressRaw could have gone through some transformations, such as only using the numeric portion, before being run through the Address Normalization Table. | [optional] |
|
13
|
+
| **address_raw** | **String** | The address as close to the bits on the wire as possible. | [optional] |
|
14
|
+
| **address_displayable** | **String** | The displayable address. This field is acquired from the Address Normalization Table. The addressRaw could have gone through some transformations, such as only using the numeric portion, before being run through the Address Normalization Table. | [optional] |
|
15
|
+
{: class="table table-striped"}
|
16
|
+
|
17
|
+
|
data/doc_out/Agent.html.md
CHANGED
@@ -7,7 +7,7 @@ title: Agent
|
|
7
7
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **stage** | **String** |
|
10
|
+
| **stage** | **String** | The current stage for this agent | [optional] |
|
11
11
|
{: class="table table-striped"}
|
12
12
|
|
13
13
|
|
@@ -12,9 +12,9 @@ title: AgentActivityEntityListing
|
|
12
12
|
| **total** | **Integer** | | [optional] |
|
13
13
|
| **entities** | [**Array<AgentActivity>**](AgentActivity.html) | | [optional] |
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
-
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **previous_uri** | **String** | | [optional] |
|
17
15
|
| **next_uri** | **String** | | [optional] |
|
16
|
+
| **previous_uri** | **String** | | [optional] |
|
17
|
+
| **first_uri** | **String** | | [optional] |
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
data/doc_out/AlertingApi.html.md
CHANGED
@@ -8,18 +8,136 @@ All URIs are relative to *https://api.mypurecloud.com*
|
|
8
8
|
|
9
9
|
Method | HTTP request | Description
|
10
10
|
------------- | ------------- | -------------
|
11
|
+
|[**delete_heartbeat_alerts_alert_id**](AlertingApi.html#delete_heartbeat_alerts_alert_id) | **DELETE** /api/v2/alerting/heartbeat/alerts/{alertId} | Delete a heart beat alert|
|
12
|
+
|[**delete_heartbeat_rules_rule_id**](AlertingApi.html#delete_heartbeat_rules_rule_id) | **DELETE** /api/v2/alerting/heartbeat/rules/{ruleId} | Delete a heart beat rule.|
|
11
13
|
|[**delete_interactionstats_alerts_alert_id**](AlertingApi.html#delete_interactionstats_alerts_alert_id) | **DELETE** /api/v2/alerting/interactionstats/alerts/{alertId} | Delete an interaction stats alert|
|
12
14
|
|[**delete_interactionstats_rules_rule_id**](AlertingApi.html#delete_interactionstats_rules_rule_id) | **DELETE** /api/v2/alerting/interactionstats/rules/{ruleId} | Delete an interaction stats rule.|
|
15
|
+
|[**get_heartbeat_alerts**](AlertingApi.html#get_heartbeat_alerts) | **GET** /api/v2/alerting/heartbeat/alerts | Get heart beat alert list.|
|
16
|
+
|[**get_heartbeat_alerts_alert_id**](AlertingApi.html#get_heartbeat_alerts_alert_id) | **GET** /api/v2/alerting/heartbeat/alerts/{alertId} | Get a heart beat alert|
|
17
|
+
|[**get_heartbeat_rules**](AlertingApi.html#get_heartbeat_rules) | **GET** /api/v2/alerting/heartbeat/rules | Get a heart beat rule list.|
|
18
|
+
|[**get_heartbeat_rules_rule_id**](AlertingApi.html#get_heartbeat_rules_rule_id) | **GET** /api/v2/alerting/heartbeat/rules/{ruleId} | Get a heart beat rule.|
|
13
19
|
|[**get_interactionstats_alerts**](AlertingApi.html#get_interactionstats_alerts) | **GET** /api/v2/alerting/interactionstats/alerts | Get interaction stats alert list.|
|
14
20
|
|[**get_interactionstats_alerts_alert_id**](AlertingApi.html#get_interactionstats_alerts_alert_id) | **GET** /api/v2/alerting/interactionstats/alerts/{alertId} | Get an interaction stats alert|
|
15
21
|
|[**get_interactionstats_alerts_unread**](AlertingApi.html#get_interactionstats_alerts_unread) | **GET** /api/v2/alerting/interactionstats/alerts/unread | Gets user unread count of interaction stats alerts.|
|
16
22
|
|[**get_interactionstats_rules**](AlertingApi.html#get_interactionstats_rules) | **GET** /api/v2/alerting/interactionstats/rules | Get an interaction stats rule list.|
|
17
23
|
|[**get_interactionstats_rules_rule_id**](AlertingApi.html#get_interactionstats_rules_rule_id) | **GET** /api/v2/alerting/interactionstats/rules/{ruleId} | Get an interaction stats rule.|
|
24
|
+
|[**post_heartbeat_rules**](AlertingApi.html#post_heartbeat_rules) | **POST** /api/v2/alerting/heartbeat/rules | Create a heart beat rule.|
|
18
25
|
|[**post_interactionstats_rules**](AlertingApi.html#post_interactionstats_rules) | **POST** /api/v2/alerting/interactionstats/rules | Create an interaction stats rule.|
|
26
|
+
|[**put_heartbeat_rules_rule_id**](AlertingApi.html#put_heartbeat_rules_rule_id) | **PUT** /api/v2/alerting/heartbeat/rules/{ruleId} | Update a heart beat rule|
|
19
27
|
|[**put_interactionstats_alerts_alert_id**](AlertingApi.html#put_interactionstats_alerts_alert_id) | **PUT** /api/v2/alerting/interactionstats/alerts/{alertId} | Update an interaction stats alert read status|
|
20
28
|
|[**put_interactionstats_rules_rule_id**](AlertingApi.html#put_interactionstats_rules_rule_id) | **PUT** /api/v2/alerting/interactionstats/rules/{ruleId} | Update an interaction stats rule|
|
21
29
|
{: class="table table-striped"}
|
22
30
|
|
31
|
+
<a name="delete_heartbeat_alerts_alert_id"></a>
|
32
|
+
|
33
|
+
## - delete_heartbeat_alerts_alert_id(alert_id)
|
34
|
+
|
35
|
+
Delete a heart beat alert
|
36
|
+
|
37
|
+
|
38
|
+
|
39
|
+
### Example
|
40
|
+
~~~ruby
|
41
|
+
# load the gem
|
42
|
+
require 'purecloud'
|
43
|
+
# setup authorization
|
44
|
+
@secret = ENV['PURECLOUD_SECRET']
|
45
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
46
|
+
environment = "mypurecloud.com"
|
47
|
+
|
48
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
49
|
+
|
50
|
+
PureCloud.configure do |config|
|
51
|
+
config.access_token = @authToken
|
52
|
+
end
|
53
|
+
|
54
|
+
api_instance = PureCloud::AlertingApi.new
|
55
|
+
|
56
|
+
alert_id = "alert_id_example" # String | Alert ID
|
57
|
+
|
58
|
+
|
59
|
+
begin
|
60
|
+
#Delete a heart beat alert
|
61
|
+
api_instance.delete_heartbeat_alerts_alert_id(alert_id)
|
62
|
+
rescue PureCloud::ApiError => e
|
63
|
+
puts "Exception when calling AlertingApi->delete_heartbeat_alerts_alert_id: #{e}"
|
64
|
+
end
|
65
|
+
~~~
|
66
|
+
|
67
|
+
### Parameters
|
68
|
+
|
69
|
+
Name | Type | Description | Notes
|
70
|
+
------------- | ------------- | ------------- | -------------
|
71
|
+
**alert_id** | **String**| Alert ID |
|
72
|
+
{: class="table table-striped"}
|
73
|
+
|
74
|
+
|
75
|
+
### Return type
|
76
|
+
|
77
|
+
nil (empty response body)
|
78
|
+
|
79
|
+
### HTTP request headers
|
80
|
+
|
81
|
+
- **Content-Type**: application/json
|
82
|
+
- **Accept**: application/json
|
83
|
+
|
84
|
+
|
85
|
+
|
86
|
+
<a name="delete_heartbeat_rules_rule_id"></a>
|
87
|
+
|
88
|
+
## - delete_heartbeat_rules_rule_id(rule_id)
|
89
|
+
|
90
|
+
Delete a heart beat rule.
|
91
|
+
|
92
|
+
|
93
|
+
|
94
|
+
### Example
|
95
|
+
~~~ruby
|
96
|
+
# load the gem
|
97
|
+
require 'purecloud'
|
98
|
+
# setup authorization
|
99
|
+
@secret = ENV['PURECLOUD_SECRET']
|
100
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
101
|
+
environment = "mypurecloud.com"
|
102
|
+
|
103
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
104
|
+
|
105
|
+
PureCloud.configure do |config|
|
106
|
+
config.access_token = @authToken
|
107
|
+
end
|
108
|
+
|
109
|
+
api_instance = PureCloud::AlertingApi.new
|
110
|
+
|
111
|
+
rule_id = "rule_id_example" # String | Rule ID
|
112
|
+
|
113
|
+
|
114
|
+
begin
|
115
|
+
#Delete a heart beat rule.
|
116
|
+
api_instance.delete_heartbeat_rules_rule_id(rule_id)
|
117
|
+
rescue PureCloud::ApiError => e
|
118
|
+
puts "Exception when calling AlertingApi->delete_heartbeat_rules_rule_id: #{e}"
|
119
|
+
end
|
120
|
+
~~~
|
121
|
+
|
122
|
+
### Parameters
|
123
|
+
|
124
|
+
Name | Type | Description | Notes
|
125
|
+
------------- | ------------- | ------------- | -------------
|
126
|
+
**rule_id** | **String**| Rule ID |
|
127
|
+
{: class="table table-striped"}
|
128
|
+
|
129
|
+
|
130
|
+
### Return type
|
131
|
+
|
132
|
+
nil (empty response body)
|
133
|
+
|
134
|
+
### HTTP request headers
|
135
|
+
|
136
|
+
- **Content-Type**: application/json
|
137
|
+
- **Accept**: application/json
|
138
|
+
|
139
|
+
|
140
|
+
|
23
141
|
<a name="delete_interactionstats_alerts_alert_id"></a>
|
24
142
|
|
25
143
|
## - delete_interactionstats_alerts_alert_id(alert_id)
|
@@ -130,6 +248,218 @@ nil (empty response body)
|
|
130
248
|
|
131
249
|
|
132
250
|
|
251
|
+
<a name="get_heartbeat_alerts"></a>
|
252
|
+
|
253
|
+
## -[**HeartBeatAlertContainer**](HeartBeatAlertContainer.html) get_heartbeat_alerts
|
254
|
+
|
255
|
+
Get heart beat alert list.
|
256
|
+
|
257
|
+
|
258
|
+
|
259
|
+
### Example
|
260
|
+
~~~ruby
|
261
|
+
# load the gem
|
262
|
+
require 'purecloud'
|
263
|
+
# setup authorization
|
264
|
+
@secret = ENV['PURECLOUD_SECRET']
|
265
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
266
|
+
environment = "mypurecloud.com"
|
267
|
+
|
268
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
269
|
+
|
270
|
+
PureCloud.configure do |config|
|
271
|
+
config.access_token = @authToken
|
272
|
+
end
|
273
|
+
|
274
|
+
api_instance = PureCloud::AlertingApi.new
|
275
|
+
|
276
|
+
begin
|
277
|
+
#Get heart beat alert list.
|
278
|
+
result = api_instance.get_heartbeat_alerts
|
279
|
+
p result
|
280
|
+
rescue PureCloud::ApiError => e
|
281
|
+
puts "Exception when calling AlertingApi->get_heartbeat_alerts: #{e}"
|
282
|
+
end
|
283
|
+
~~~
|
284
|
+
|
285
|
+
### Parameters
|
286
|
+
This endpoint does not need any parameter.
|
287
|
+
{: class="table table-striped"}
|
288
|
+
|
289
|
+
|
290
|
+
### Return type
|
291
|
+
|
292
|
+
[**HeartBeatAlertContainer**](HeartBeatAlertContainer.html)
|
293
|
+
|
294
|
+
### HTTP request headers
|
295
|
+
|
296
|
+
- **Content-Type**: application/json
|
297
|
+
- **Accept**: application/json
|
298
|
+
|
299
|
+
|
300
|
+
|
301
|
+
<a name="get_heartbeat_alerts_alert_id"></a>
|
302
|
+
|
303
|
+
## -[**HeartBeatAlert**](HeartBeatAlert.html) get_heartbeat_alerts_alert_id(alert_id)
|
304
|
+
|
305
|
+
Get a heart beat alert
|
306
|
+
|
307
|
+
|
308
|
+
|
309
|
+
### Example
|
310
|
+
~~~ruby
|
311
|
+
# load the gem
|
312
|
+
require 'purecloud'
|
313
|
+
# setup authorization
|
314
|
+
@secret = ENV['PURECLOUD_SECRET']
|
315
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
316
|
+
environment = "mypurecloud.com"
|
317
|
+
|
318
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
319
|
+
|
320
|
+
PureCloud.configure do |config|
|
321
|
+
config.access_token = @authToken
|
322
|
+
end
|
323
|
+
|
324
|
+
api_instance = PureCloud::AlertingApi.new
|
325
|
+
|
326
|
+
alert_id = "alert_id_example" # String | Alert ID
|
327
|
+
|
328
|
+
|
329
|
+
begin
|
330
|
+
#Get a heart beat alert
|
331
|
+
result = api_instance.get_heartbeat_alerts_alert_id(alert_id)
|
332
|
+
p result
|
333
|
+
rescue PureCloud::ApiError => e
|
334
|
+
puts "Exception when calling AlertingApi->get_heartbeat_alerts_alert_id: #{e}"
|
335
|
+
end
|
336
|
+
~~~
|
337
|
+
|
338
|
+
### Parameters
|
339
|
+
|
340
|
+
Name | Type | Description | Notes
|
341
|
+
------------- | ------------- | ------------- | -------------
|
342
|
+
**alert_id** | **String**| Alert ID |
|
343
|
+
{: class="table table-striped"}
|
344
|
+
|
345
|
+
|
346
|
+
### Return type
|
347
|
+
|
348
|
+
[**HeartBeatAlert**](HeartBeatAlert.html)
|
349
|
+
|
350
|
+
### HTTP request headers
|
351
|
+
|
352
|
+
- **Content-Type**: application/json
|
353
|
+
- **Accept**: application/json
|
354
|
+
|
355
|
+
|
356
|
+
|
357
|
+
<a name="get_heartbeat_rules"></a>
|
358
|
+
|
359
|
+
## -[**HeartBeatRuleContainer**](HeartBeatRuleContainer.html) get_heartbeat_rules
|
360
|
+
|
361
|
+
Get a heart beat rule list.
|
362
|
+
|
363
|
+
|
364
|
+
|
365
|
+
### Example
|
366
|
+
~~~ruby
|
367
|
+
# load the gem
|
368
|
+
require 'purecloud'
|
369
|
+
# setup authorization
|
370
|
+
@secret = ENV['PURECLOUD_SECRET']
|
371
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
372
|
+
environment = "mypurecloud.com"
|
373
|
+
|
374
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
375
|
+
|
376
|
+
PureCloud.configure do |config|
|
377
|
+
config.access_token = @authToken
|
378
|
+
end
|
379
|
+
|
380
|
+
api_instance = PureCloud::AlertingApi.new
|
381
|
+
|
382
|
+
begin
|
383
|
+
#Get a heart beat rule list.
|
384
|
+
result = api_instance.get_heartbeat_rules
|
385
|
+
p result
|
386
|
+
rescue PureCloud::ApiError => e
|
387
|
+
puts "Exception when calling AlertingApi->get_heartbeat_rules: #{e}"
|
388
|
+
end
|
389
|
+
~~~
|
390
|
+
|
391
|
+
### Parameters
|
392
|
+
This endpoint does not need any parameter.
|
393
|
+
{: class="table table-striped"}
|
394
|
+
|
395
|
+
|
396
|
+
### Return type
|
397
|
+
|
398
|
+
[**HeartBeatRuleContainer**](HeartBeatRuleContainer.html)
|
399
|
+
|
400
|
+
### HTTP request headers
|
401
|
+
|
402
|
+
- **Content-Type**: application/json
|
403
|
+
- **Accept**: application/json
|
404
|
+
|
405
|
+
|
406
|
+
|
407
|
+
<a name="get_heartbeat_rules_rule_id"></a>
|
408
|
+
|
409
|
+
## -[**HeartBeatRule**](HeartBeatRule.html) get_heartbeat_rules_rule_id(rule_id)
|
410
|
+
|
411
|
+
Get a heart beat rule.
|
412
|
+
|
413
|
+
|
414
|
+
|
415
|
+
### Example
|
416
|
+
~~~ruby
|
417
|
+
# load the gem
|
418
|
+
require 'purecloud'
|
419
|
+
# setup authorization
|
420
|
+
@secret = ENV['PURECLOUD_SECRET']
|
421
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
422
|
+
environment = "mypurecloud.com"
|
423
|
+
|
424
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
425
|
+
|
426
|
+
PureCloud.configure do |config|
|
427
|
+
config.access_token = @authToken
|
428
|
+
end
|
429
|
+
|
430
|
+
api_instance = PureCloud::AlertingApi.new
|
431
|
+
|
432
|
+
rule_id = "rule_id_example" # String | Rule ID
|
433
|
+
|
434
|
+
|
435
|
+
begin
|
436
|
+
#Get a heart beat rule.
|
437
|
+
result = api_instance.get_heartbeat_rules_rule_id(rule_id)
|
438
|
+
p result
|
439
|
+
rescue PureCloud::ApiError => e
|
440
|
+
puts "Exception when calling AlertingApi->get_heartbeat_rules_rule_id: #{e}"
|
441
|
+
end
|
442
|
+
~~~
|
443
|
+
|
444
|
+
### Parameters
|
445
|
+
|
446
|
+
Name | Type | Description | Notes
|
447
|
+
------------- | ------------- | ------------- | -------------
|
448
|
+
**rule_id** | **String**| Rule ID |
|
449
|
+
{: class="table table-striped"}
|
450
|
+
|
451
|
+
|
452
|
+
### Return type
|
453
|
+
|
454
|
+
[**HeartBeatRule**](HeartBeatRule.html)
|
455
|
+
|
456
|
+
### HTTP request headers
|
457
|
+
|
458
|
+
- **Content-Type**: application/json
|
459
|
+
- **Accept**: application/json
|
460
|
+
|
461
|
+
|
462
|
+
|
133
463
|
<a name="get_interactionstats_alerts"></a>
|
134
464
|
|
135
465
|
## -[**InteractionStatsAlertContainer**](InteractionStatsAlertContainer.html) get_interactionstats_alerts
|
@@ -392,6 +722,62 @@ Name | Type | Description | Notes
|
|
392
722
|
|
393
723
|
|
394
724
|
|
725
|
+
<a name="post_heartbeat_rules"></a>
|
726
|
+
|
727
|
+
## -[**HeartBeatRule**](HeartBeatRule.html) post_heartbeat_rules(body)
|
728
|
+
|
729
|
+
Create a heart beat rule.
|
730
|
+
|
731
|
+
|
732
|
+
|
733
|
+
### Example
|
734
|
+
~~~ruby
|
735
|
+
# load the gem
|
736
|
+
require 'purecloud'
|
737
|
+
# setup authorization
|
738
|
+
@secret = ENV['PURECLOUD_SECRET']
|
739
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
740
|
+
environment = "mypurecloud.com"
|
741
|
+
|
742
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
743
|
+
|
744
|
+
PureCloud.configure do |config|
|
745
|
+
config.access_token = @authToken
|
746
|
+
end
|
747
|
+
|
748
|
+
api_instance = PureCloud::AlertingApi.new
|
749
|
+
|
750
|
+
body = PureCloud::HeartBeatRule.new # HeartBeatRule | HeartBeatRule
|
751
|
+
|
752
|
+
|
753
|
+
begin
|
754
|
+
#Create a heart beat rule.
|
755
|
+
result = api_instance.post_heartbeat_rules(body)
|
756
|
+
p result
|
757
|
+
rescue PureCloud::ApiError => e
|
758
|
+
puts "Exception when calling AlertingApi->post_heartbeat_rules: #{e}"
|
759
|
+
end
|
760
|
+
~~~
|
761
|
+
|
762
|
+
### Parameters
|
763
|
+
|
764
|
+
Name | Type | Description | Notes
|
765
|
+
------------- | ------------- | ------------- | -------------
|
766
|
+
**body** | [**HeartBeatRule**](HeartBeatRule.html)| HeartBeatRule |
|
767
|
+
{: class="table table-striped"}
|
768
|
+
|
769
|
+
|
770
|
+
### Return type
|
771
|
+
|
772
|
+
[**HeartBeatRule**](HeartBeatRule.html)
|
773
|
+
|
774
|
+
### HTTP request headers
|
775
|
+
|
776
|
+
- **Content-Type**: application/json
|
777
|
+
- **Accept**: application/json
|
778
|
+
|
779
|
+
|
780
|
+
|
395
781
|
<a name="post_interactionstats_rules"></a>
|
396
782
|
|
397
783
|
## -[**InteractionStatsRule**](InteractionStatsRule.html) post_interactionstats_rules(body)
|
@@ -448,6 +834,65 @@ Name | Type | Description | Notes
|
|
448
834
|
|
449
835
|
|
450
836
|
|
837
|
+
<a name="put_heartbeat_rules_rule_id"></a>
|
838
|
+
|
839
|
+
## -[**HeartBeatRule**](HeartBeatRule.html) put_heartbeat_rules_rule_id(rule_id, body)
|
840
|
+
|
841
|
+
Update a heart beat rule
|
842
|
+
|
843
|
+
|
844
|
+
|
845
|
+
### Example
|
846
|
+
~~~ruby
|
847
|
+
# load the gem
|
848
|
+
require 'purecloud'
|
849
|
+
# setup authorization
|
850
|
+
@secret = ENV['PURECLOUD_SECRET']
|
851
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
852
|
+
environment = "mypurecloud.com"
|
853
|
+
|
854
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
855
|
+
|
856
|
+
PureCloud.configure do |config|
|
857
|
+
config.access_token = @authToken
|
858
|
+
end
|
859
|
+
|
860
|
+
api_instance = PureCloud::AlertingApi.new
|
861
|
+
|
862
|
+
rule_id = "rule_id_example" # String | Rule ID
|
863
|
+
|
864
|
+
body = PureCloud::HeartBeatRule.new # HeartBeatRule | HeartBeatRule
|
865
|
+
|
866
|
+
|
867
|
+
begin
|
868
|
+
#Update a heart beat rule
|
869
|
+
result = api_instance.put_heartbeat_rules_rule_id(rule_id, body)
|
870
|
+
p result
|
871
|
+
rescue PureCloud::ApiError => e
|
872
|
+
puts "Exception when calling AlertingApi->put_heartbeat_rules_rule_id: #{e}"
|
873
|
+
end
|
874
|
+
~~~
|
875
|
+
|
876
|
+
### Parameters
|
877
|
+
|
878
|
+
Name | Type | Description | Notes
|
879
|
+
------------- | ------------- | ------------- | -------------
|
880
|
+
**rule_id** | **String**| Rule ID |
|
881
|
+
**body** | [**HeartBeatRule**](HeartBeatRule.html)| HeartBeatRule |
|
882
|
+
{: class="table table-striped"}
|
883
|
+
|
884
|
+
|
885
|
+
### Return type
|
886
|
+
|
887
|
+
[**HeartBeatRule**](HeartBeatRule.html)
|
888
|
+
|
889
|
+
### HTTP request headers
|
890
|
+
|
891
|
+
- **Content-Type**: application/json
|
892
|
+
- **Accept**: application/json
|
893
|
+
|
894
|
+
|
895
|
+
|
451
896
|
<a name="put_interactionstats_alerts_alert_id"></a>
|
452
897
|
|
453
898
|
## -[**UnreadStatus**](UnreadStatus.html) put_interactionstats_alerts_alert_id(alert_id, body)
|