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
@@ -0,0 +1,28 @@
|
|
1
|
+
---
|
2
|
+
title: InteractionStatAlertNotification
|
3
|
+
---
|
4
|
+
## PureCloud::InteractionStatAlertNotification
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **id** | **String** | | [optional] |
|
11
|
+
| **name** | **String** | | [optional] |
|
12
|
+
| **rule_id** | **String** | | [optional] |
|
13
|
+
| **dimension** | **String** | | [optional] |
|
14
|
+
| **dimension_value** | **String** | | [optional] |
|
15
|
+
| **dimension_value_name** | **String** | | [optional] |
|
16
|
+
| **metric** | **String** | | [optional] |
|
17
|
+
| **media_type** | **String** | | [optional] |
|
18
|
+
| **numeric_range** | **String** | | [optional] |
|
19
|
+
| **statistic** | **String** | | [optional] |
|
20
|
+
| **value** | **Float** | | [optional] |
|
21
|
+
| **unread** | **BOOLEAN** | | [optional] |
|
22
|
+
| **start_date** | **DateTime** | | [optional] |
|
23
|
+
| **end_date** | **DateTime** | | [optional] |
|
24
|
+
| **notification_users** | [**Array<HeartBeatAlertNotificationNotificationUsers>**](HeartBeatAlertNotificationNotificationUsers.html) | | [optional] |
|
25
|
+
| **alert_types** | **Array<String>** | | [optional] |
|
26
|
+
{: class="table table-striped"}
|
27
|
+
|
28
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
---
|
2
|
+
title: InteractionStatAlertNotificationNotificationUser
|
3
|
+
---
|
4
|
+
## PureCloud::InteractionStatAlertNotificationNotificationUser
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **id** | **String** | | [optional] |
|
11
|
+
| **display_name** | **String** | | [optional] |
|
12
|
+
{: class="table table-striped"}
|
13
|
+
|
14
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
---
|
2
|
+
title: InteractionStatRuleNotification
|
3
|
+
---
|
4
|
+
## PureCloud::InteractionStatRuleNotification
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **id** | **String** | | [optional] |
|
11
|
+
| **name** | **String** | | [optional] |
|
12
|
+
| **dimension** | **String** | | [optional] |
|
13
|
+
| **dimension_value** | **String** | | [optional] |
|
14
|
+
| **dimension_value_name** | **String** | | [optional] |
|
15
|
+
| **metric** | **String** | | [optional] |
|
16
|
+
| **media_type** | **String** | | [optional] |
|
17
|
+
| **numeric_range** | **String** | | [optional] |
|
18
|
+
| **statistic** | **String** | | [optional] |
|
19
|
+
| **value** | **Float** | | [optional] |
|
20
|
+
| **in_alarm** | **BOOLEAN** | | [optional] |
|
21
|
+
| **enabled** | **BOOLEAN** | | [optional] |
|
22
|
+
| **notification_users** | [**Array<HeartBeatAlertNotificationNotificationUsers>**](HeartBeatAlertNotificationNotificationUsers.html) | | [optional] |
|
23
|
+
| **alert_types** | **Array<String>** | | [optional] |
|
24
|
+
{: class="table table-striped"}
|
25
|
+
|
26
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
---
|
2
|
+
title: InteractionStatRuleNotificationNotificationUser
|
3
|
+
---
|
4
|
+
## PureCloud::InteractionStatRuleNotificationNotificationUser
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **id** | **String** | | [optional] |
|
11
|
+
| **display_name** | **String** | | [optional] |
|
12
|
+
{: class="table table-striped"}
|
13
|
+
|
14
|
+
|
@@ -12,9 +12,9 @@ title: InteractionStatsAlertContainer
|
|
12
12
|
| **total** | **Integer** | | [optional] |
|
13
13
|
| **entities** | [**Array<InteractionStatsAlert>**](InteractionStatsAlert.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"}
|
@@ -12,9 +12,9 @@ title: InteractionStatsRuleContainer
|
|
12
12
|
| **total** | **Integer** | | [optional] |
|
13
13
|
| **entities** | [**Array<InteractionStatsRule>**](InteractionStatsRule.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/JsonNode.html.md
CHANGED
@@ -8,10 +8,10 @@ title: JsonNode
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
10
|
| **node_type** | **String** | | [optional] |
|
11
|
-
| **float** | **BOOLEAN** | | [optional] [default to false]|
|
12
|
-
| **boolean** | **BOOLEAN** | | [optional] [default to false]|
|
13
11
|
| **object** | **BOOLEAN** | | [optional] [default to false]|
|
12
|
+
| **boolean** | **BOOLEAN** | | [optional] [default to false]|
|
14
13
|
| **number** | **BOOLEAN** | | [optional] [default to false]|
|
14
|
+
| **float** | **BOOLEAN** | | [optional] [default to false]|
|
15
15
|
| **value_node** | **BOOLEAN** | | [optional] [default to false]|
|
16
16
|
| **container_node** | **BOOLEAN** | | [optional] [default to false]|
|
17
17
|
| **missing_node** | **BOOLEAN** | | [optional] [default to false]|
|
data/doc_out/Keyword.html.md
CHANGED
@@ -13,7 +13,10 @@ title: Keyword
|
|
13
13
|
| **confidence** | **Integer** | A sensitivity threshold that can be increased to lower false positives or decreased to reduce false negatives. | |
|
14
14
|
| **agent_score_modifier** | **Integer** | A modifier to the evaluation score when the phrase is spotted in the agent channel | |
|
15
15
|
| **customer_score_modifier** | **Integer** | A modifier to the evaluation score when the phrase is spotted in the customer channel | |
|
16
|
-
| **alternate_spellings** | **Array<String>** |
|
16
|
+
| **alternate_spellings** | **Array<String>** | Other spellings of the phrase that can be added to reduce missed spots (false negatives). | [optional] |
|
17
|
+
| **pronunciations** | **Array<String>** | The phonetic spellings for the phrase and alternate spellings. | [optional] |
|
18
|
+
| **anti_words** | **Array<String>** | Words that are similar to the phrase but not desired. Added to reduce incorrect spots (false positives). | [optional] |
|
19
|
+
| **anti_pronunciations** | **Array<String>** | The phonetic spellings for the antiWords. | [optional] |
|
17
20
|
| **spotability_index** | **Float** | A prediction of how easy it is to unambiguously spot the keyword within its language based on spelling. | [optional] |
|
18
21
|
| **margin_of_error** | **Float** | | [optional] |
|
19
22
|
| **pronunciation** | **String** | | [optional] |
|
data/doc_out/KeywordSet.html.md
CHANGED
@@ -15,7 +15,7 @@ title: KeywordSet
|
|
15
15
|
| **language** | **String** | Language code, such as 'en-US' | |
|
16
16
|
| **agents** | [**Array<User>**](User.html) | | [optional] |
|
17
17
|
| **keywords** | [**Array<Keyword>**](Keyword.html) | The list of keywords to be used for keyword spotting. | |
|
18
|
-
| **participant_purposes** | **Array<String>** |
|
18
|
+
| **participant_purposes** | **Array<String>** | The types of participants to use keyword spotting on. | |
|
19
19
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -12,9 +12,9 @@ title: KeywordSetEntityListing
|
|
12
12
|
| **total** | **Integer** | | [optional] |
|
13
13
|
| **entities** | [**Array<KeywordSet>**](KeywordSet.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/Language.html.md
CHANGED
@@ -8,7 +8,7 @@ title: Language
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
10
|
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
11
|
-
| **name** | **String** |
|
11
|
+
| **name** | **String** | The language name. | |
|
12
12
|
| **date_modified** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
13
13
|
| **state** | **String** | | [optional] |
|
14
14
|
| **version** | **String** | | [optional] |
|
@@ -12,9 +12,9 @@ title: LanguageEntityListing
|
|
12
12
|
| **total** | **Integer** | | [optional] |
|
13
13
|
| **entities** | [**Array<Language>**](Language.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/Library.html.md
CHANGED
@@ -8,7 +8,7 @@ title: Library
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
10
|
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
11
|
-
| **name** | **String** |
|
11
|
+
| **name** | **String** | The library name. | |
|
12
12
|
| **version** | **Integer** | | [optional] |
|
13
13
|
| **created_by** | [**User**](User.html) | | [optional] |
|
14
14
|
| **date_created** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
@@ -12,9 +12,9 @@ title: LibraryEntityListing
|
|
12
12
|
| **total** | **Integer** | | [optional] |
|
13
13
|
| **entities** | [**Array<Library>**](Library.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"}
|
@@ -12,9 +12,9 @@ title: LineBaseEntityListing
|
|
12
12
|
| **total** | **Integer** | | [optional] |
|
13
13
|
| **entities** | [**Array<LineBase>**](LineBase.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"}
|
@@ -12,9 +12,9 @@ title: LineEntityListing
|
|
12
12
|
| **total** | **Integer** | | [optional] |
|
13
13
|
| **entities** | [**Array<Line>**](Line.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"}
|
@@ -156,10 +156,10 @@ end
|
|
156
156
|
|
157
157
|
api_instance = PureCloud::LocationsApi.new
|
158
158
|
|
159
|
-
q64 = "q64_example" # String |
|
159
|
+
q64 = "q64_example" # String | q64
|
160
160
|
|
161
161
|
opts = {
|
162
|
-
expand: ["expand_example"] # Array<String> |
|
162
|
+
expand: ["expand_example"] # Array<String> | expand
|
163
163
|
}
|
164
164
|
|
165
165
|
begin
|
@@ -175,8 +175,8 @@ end
|
|
175
175
|
|
176
176
|
Name | Type | Description | Notes
|
177
177
|
------------- | ------------- | ------------- | -------------
|
178
|
-
**q64** | **String**|
|
179
|
-
**expand** | [**Array<String>**](String.html)|
|
178
|
+
**q64** | **String**| q64 |
|
179
|
+
**expand** | [**Array<String>**](String.html)| expand | [optional]
|
180
180
|
{: class="table table-striped"}
|
181
181
|
|
182
182
|
|
@@ -12,9 +12,9 @@ title: LogicalInterfaceEntityListing
|
|
12
12
|
| **total** | **Integer** | | [optional] |
|
13
13
|
| **entities** | [**Array<DomainLogicalInterface>**](DomainLogicalInterface.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"}
|
@@ -7,7 +7,7 @@ title: MaxParticipants
|
|
7
7
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **max_participants** | **Integer** |
|
10
|
+
| **max_participants** | **Integer** | The maximum number of participants that are allowed on a conversation. | [optional] |
|
11
11
|
{: class="table table-striped"}
|
12
12
|
|
13
13
|
|
@@ -0,0 +1,15 @@
|
|
1
|
+
---
|
2
|
+
title: MetaData
|
3
|
+
---
|
4
|
+
## PureCloud::MetaData
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **pairing_token** | **String** | | [optional] |
|
11
|
+
| **pairing_trust** | **Array<String>** | | [optional] |
|
12
|
+
| **pairing_url** | **String** | | [optional] |
|
13
|
+
{: class="table table-striped"}
|
14
|
+
|
15
|
+
|
@@ -12,9 +12,9 @@ title: OAuthClientEntityListing
|
|
12
12
|
| **total** | **Integer** | | [optional] |
|
13
13
|
| **entities** | [**Array<OAuthClient>**](OAuthClient.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"}
|
@@ -12,9 +12,9 @@ title: OAuthProviderEntityListing
|
|
12
12
|
| **total** | **Integer** | | [optional] |
|
13
13
|
| **entities** | [**Array<OAuthProvider>**](OAuthProvider.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"}
|
@@ -9,7 +9,7 @@ title: OrganizationPresence
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
10
|
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
11
11
|
| **name** | **String** | | [optional] |
|
12
|
-
| **language_labels** | **Hash<String, String>** |
|
12
|
+
| **language_labels** | **Hash<String, String>** | The label used for the system presence in each specified language | |
|
13
13
|
| **system_presence** | **String** | | [optional] |
|
14
14
|
| **deactivated** | **BOOLEAN** | | [optional] [default to false]|
|
15
15
|
| **primary** | **BOOLEAN** | | [optional] [default to false]|
|
@@ -12,9 +12,9 @@ title: OrganizationPresenceEntityListing
|
|
12
12
|
| **total** | **Integer** | | [optional] |
|
13
13
|
| **entities** | [**Array<OrganizationPresence>**](OrganizationPresence.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"}
|
@@ -12,9 +12,9 @@ title: OrganizationRoleEntityListing
|
|
12
12
|
| **total** | **Integer** | | [optional] |
|
13
13
|
| **entities** | [**Array<DomainOrganizationRole>**](DomainOrganizationRole.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"}
|
@@ -12,9 +12,9 @@ title: OrphanRecordingListing
|
|
12
12
|
| **total** | **Integer** | | [optional] |
|
13
13
|
| **entities** | [**Array<OrphanRecording>**](OrphanRecording.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"}
|
@@ -0,0 +1,17 @@
|
|
1
|
+
---
|
2
|
+
title: OutOfOfficeNotification
|
3
|
+
---
|
4
|
+
## PureCloud::OutOfOfficeNotification
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **user** | [**OutOfOfficeNotificationUser**](OutOfOfficeNotificationUser.html) | | [optional] |
|
11
|
+
| **active** | **BOOLEAN** | | [optional] |
|
12
|
+
| **start_date** | **DateTime** | | [optional] |
|
13
|
+
| **end_date** | **DateTime** | | [optional] |
|
14
|
+
| **modified_date** | **DateTime** | | [optional] |
|
15
|
+
{: class="table table-striped"}
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,13 @@
|
|
1
|
+
---
|
2
|
+
title: OutOfOfficeNotificationUser
|
3
|
+
---
|
4
|
+
## PureCloud::OutOfOfficeNotificationUser
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **id** | **String** | | [optional] |
|
11
|
+
{: class="table table-striped"}
|
12
|
+
|
13
|
+
|
data/doc_out/OutboundApi.html.md
CHANGED
@@ -8,6 +8,7 @@ All URIs are relative to *https://api.mypurecloud.com*
|
|
8
8
|
|
9
9
|
Method | HTTP request | Description
|
10
10
|
------------- | ------------- | -------------
|
11
|
+
|[**delete_attemptlimits_attemptlimits_id**](OutboundApi.html#delete_attemptlimits_attemptlimits_id) | **DELETE** /api/v2/outbound/attemptlimits/{attemptLimitsId} | Delete attempt limits|
|
11
12
|
|[**delete_callabletimesets_callabletimeset_id**](OutboundApi.html#delete_callabletimesets_callabletimeset_id) | **DELETE** /api/v2/outbound/callabletimesets/{callableTimeSetId} | Delete callable time set|
|
12
13
|
|[**delete_callanalysisresponsesets_callanalysisset_id**](OutboundApi.html#delete_callanalysisresponsesets_callanalysisset_id) | **DELETE** /api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId} | Delete a dialer call analysis response set.|
|
13
14
|
|[**delete_campaigns_campaign_id**](OutboundApi.html#delete_campaigns_campaign_id) | **DELETE** /api/v2/outbound/campaigns/{campaignId} | Delete a campaign.|
|
@@ -19,6 +20,8 @@ Method | HTTP request | Description
|
|
19
20
|
|[**delete_schedules_campaigns_campaign_id**](OutboundApi.html#delete_schedules_campaigns_campaign_id) | **DELETE** /api/v2/outbound/schedules/campaigns/{campaignId} | Delete a dialer campaign schedule.|
|
20
21
|
|[**delete_schedules_sequences_sequence_id**](OutboundApi.html#delete_schedules_sequences_sequence_id) | **DELETE** /api/v2/outbound/schedules/sequences/{sequenceId} | Delete a dialer sequence schedule.|
|
21
22
|
|[**delete_sequences_sequence_id**](OutboundApi.html#delete_sequences_sequence_id) | **DELETE** /api/v2/outbound/sequences/{sequenceId} | Delete a dialer campaign sequence.|
|
23
|
+
|[**get_attemptlimits**](OutboundApi.html#get_attemptlimits) | **GET** /api/v2/outbound/attemptlimits | Query attempt limits list|
|
24
|
+
|[**get_attemptlimits_attemptlimits_id**](OutboundApi.html#get_attemptlimits_attemptlimits_id) | **GET** /api/v2/outbound/attemptlimits/{attemptLimitsId} | Get attempt limits|
|
22
25
|
|[**get_callabletimesets**](OutboundApi.html#get_callabletimesets) | **GET** /api/v2/outbound/callabletimesets | Query callable time set list|
|
23
26
|
|[**get_callabletimesets_callabletimeset_id**](OutboundApi.html#get_callabletimesets_callabletimeset_id) | **GET** /api/v2/outbound/callabletimesets/{callableTimeSetId} | Get callable time set|
|
24
27
|
|[**get_callanalysisresponsesets**](OutboundApi.html#get_callanalysisresponsesets) | **GET** /api/v2/outbound/callanalysisresponsesets | Query a list of dialer call analysis response sets.|
|
@@ -26,6 +29,7 @@ Method | HTTP request | Description
|
|
26
29
|
|[**get_campaigns**](OutboundApi.html#get_campaigns) | **GET** /api/v2/outbound/campaigns | Query a list of dialer campaigns.|
|
27
30
|
|[**get_campaigns_campaign_id**](OutboundApi.html#get_campaigns_campaign_id) | **GET** /api/v2/outbound/campaigns/{campaignId} | Get dialer campaign.|
|
28
31
|
|[**get_campaigns_campaign_id_diagnostics**](OutboundApi.html#get_campaigns_campaign_id_diagnostics) | **GET** /api/v2/outbound/campaigns/{campaignId}/diagnostics | Get campaign diagnostics|
|
32
|
+
|[**get_campaigns_campaign_id_interactions**](OutboundApi.html#get_campaigns_campaign_id_interactions) | **GET** /api/v2/outbound/campaigns/{campaignId}/interactions | Get dialer campaign interactions.|
|
29
33
|
|[**get_campaigns_campaign_id_progress**](OutboundApi.html#get_campaigns_campaign_id_progress) | **GET** /api/v2/outbound/campaigns/{campaignId}/progress | Get campaign progress|
|
30
34
|
|[**get_campaigns_campaign_id_stats**](OutboundApi.html#get_campaigns_campaign_id_stats) | **GET** /api/v2/outbound/campaigns/{campaignId}/stats | Get statistics about a Dialer Campaign|
|
31
35
|
|[**get_contactlists**](OutboundApi.html#get_contactlists) | **GET** /api/v2/outbound/contactlists | Query a list of contact lists.|
|
@@ -46,6 +50,7 @@ Method | HTTP request | Description
|
|
46
50
|
|[**get_sequences**](OutboundApi.html#get_sequences) | **GET** /api/v2/outbound/sequences | Query a list of dialer campaign sequences.|
|
47
51
|
|[**get_sequences_sequence_id**](OutboundApi.html#get_sequences_sequence_id) | **GET** /api/v2/outbound/sequences/{sequenceId} | Get a dialer campaign sequence.|
|
48
52
|
|[**get_wrapupcodemappings**](OutboundApi.html#get_wrapupcodemappings) | **GET** /api/v2/outbound/wrapupcodemappings | Get the Dialer wrap up code mapping.|
|
53
|
+
|[**post_attemptlimits**](OutboundApi.html#post_attemptlimits) | **POST** /api/v2/outbound/attemptlimits | Create attempt limits|
|
49
54
|
|[**post_audits**](OutboundApi.html#post_audits) | **POST** /api/v2/outbound/audits | Retrieves audits for dialer.|
|
50
55
|
|[**post_callabletimesets**](OutboundApi.html#post_callabletimesets) | **POST** /api/v2/outbound/callabletimesets | Create callable time set|
|
51
56
|
|[**post_callanalysisresponsesets**](OutboundApi.html#post_callanalysisresponsesets) | **POST** /api/v2/outbound/callanalysisresponsesets | Create a dialer call analysis response set.|
|
@@ -61,6 +66,7 @@ Method | HTTP request | Description
|
|
61
66
|
|[**post_dnclists_dnclist_id_phonenumbers**](OutboundApi.html#post_dnclists_dnclist_id_phonenumbers) | **POST** /api/v2/outbound/dnclists/{dncListId}/phonenumbers | Add phone numbers to a Dialer DNC list.|
|
62
67
|
|[**post_rulesets**](OutboundApi.html#post_rulesets) | **POST** /api/v2/outbound/rulesets | Create a Dialer Call Analysis Response Set.|
|
63
68
|
|[**post_sequences**](OutboundApi.html#post_sequences) | **POST** /api/v2/outbound/sequences | Create a new campaign sequence.|
|
69
|
+
|[**put_attemptlimits_attemptlimits_id**](OutboundApi.html#put_attemptlimits_attemptlimits_id) | **PUT** /api/v2/outbound/attemptlimits/{attemptLimitsId} | Update attempt limits|
|
64
70
|
|[**put_callabletimesets_callabletimeset_id**](OutboundApi.html#put_callabletimesets_callabletimeset_id) | **PUT** /api/v2/outbound/callabletimesets/{callableTimeSetId} | Update callable time set|
|
65
71
|
|[**put_callanalysisresponsesets_callanalysisset_id**](OutboundApi.html#put_callanalysisresponsesets_callanalysisset_id) | **PUT** /api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId} | Update a dialer call analysis response set.|
|
66
72
|
|[**put_campaigns_campaign_id**](OutboundApi.html#put_campaigns_campaign_id) | **PUT** /api/v2/outbound/campaigns/{campaignId} | Update a campaign.|
|
@@ -75,6 +81,62 @@ Method | HTTP request | Description
|
|
75
81
|
|[**put_wrapupcodemappings**](OutboundApi.html#put_wrapupcodemappings) | **PUT** /api/v2/outbound/wrapupcodemappings | Update the Dialer wrap up code mapping.|
|
76
82
|
{: class="table table-striped"}
|
77
83
|
|
84
|
+
<a name="delete_attemptlimits_attemptlimits_id"></a>
|
85
|
+
|
86
|
+
## -String** delete_attemptlimits_attemptlimits_id(attempt_limits_id)
|
87
|
+
|
88
|
+
Delete attempt limits
|
89
|
+
|
90
|
+
|
91
|
+
|
92
|
+
### Example
|
93
|
+
~~~ruby
|
94
|
+
# load the gem
|
95
|
+
require 'purecloud'
|
96
|
+
# setup authorization
|
97
|
+
@secret = ENV['PURECLOUD_SECRET']
|
98
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
99
|
+
environment = "mypurecloud.com"
|
100
|
+
|
101
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
102
|
+
|
103
|
+
PureCloud.configure do |config|
|
104
|
+
config.access_token = @authToken
|
105
|
+
end
|
106
|
+
|
107
|
+
api_instance = PureCloud::OutboundApi.new
|
108
|
+
|
109
|
+
attempt_limits_id = "attempt_limits_id_example" # String | Attempt limits ID
|
110
|
+
|
111
|
+
|
112
|
+
begin
|
113
|
+
#Delete attempt limits
|
114
|
+
result = api_instance.delete_attemptlimits_attemptlimits_id(attempt_limits_id)
|
115
|
+
p result
|
116
|
+
rescue PureCloud::ApiError => e
|
117
|
+
puts "Exception when calling OutboundApi->delete_attemptlimits_attemptlimits_id: #{e}"
|
118
|
+
end
|
119
|
+
~~~
|
120
|
+
|
121
|
+
### Parameters
|
122
|
+
|
123
|
+
Name | Type | Description | Notes
|
124
|
+
------------- | ------------- | ------------- | -------------
|
125
|
+
**attempt_limits_id** | **String**| Attempt limits ID |
|
126
|
+
{: class="table table-striped"}
|
127
|
+
|
128
|
+
|
129
|
+
### Return type
|
130
|
+
|
131
|
+
**String**
|
132
|
+
|
133
|
+
### HTTP request headers
|
134
|
+
|
135
|
+
- **Content-Type**: application/json
|
136
|
+
- **Accept**: application/json
|
137
|
+
|
138
|
+
|
139
|
+
|
78
140
|
<a name="delete_callabletimesets_callabletimeset_id"></a>
|
79
141
|
|
80
142
|
## -String** delete_callabletimesets_callabletimeset_id(callable_time_set_id)
|
@@ -694,6 +756,129 @@ Name | Type | Description | Notes
|
|
694
756
|
|
695
757
|
|
696
758
|
|
759
|
+
<a name="get_attemptlimits"></a>
|
760
|
+
|
761
|
+
## -[**AttemptLimitsEntityListing**](AttemptLimitsEntityListing.html) get_attemptlimits(opts)
|
762
|
+
|
763
|
+
Query attempt limits list
|
764
|
+
|
765
|
+
|
766
|
+
|
767
|
+
### Example
|
768
|
+
~~~ruby
|
769
|
+
# load the gem
|
770
|
+
require 'purecloud'
|
771
|
+
# setup authorization
|
772
|
+
@secret = ENV['PURECLOUD_SECRET']
|
773
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
774
|
+
environment = "mypurecloud.com"
|
775
|
+
|
776
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
777
|
+
|
778
|
+
PureCloud.configure do |config|
|
779
|
+
config.access_token = @authToken
|
780
|
+
end
|
781
|
+
|
782
|
+
api_instance = PureCloud::OutboundApi.new
|
783
|
+
|
784
|
+
opts = {
|
785
|
+
page_size: 25, # Integer | Page size
|
786
|
+
page_number: 1, # Integer | Page number
|
787
|
+
filter_type: "PREFIX", # String | Filter type
|
788
|
+
name: "name_example", # String | Name
|
789
|
+
sort_by: "sort_by_example", # String | Sort by
|
790
|
+
sort_order: "a" # String | Sort order
|
791
|
+
}
|
792
|
+
|
793
|
+
begin
|
794
|
+
#Query attempt limits list
|
795
|
+
result = api_instance.get_attemptlimits(opts)
|
796
|
+
p result
|
797
|
+
rescue PureCloud::ApiError => e
|
798
|
+
puts "Exception when calling OutboundApi->get_attemptlimits: #{e}"
|
799
|
+
end
|
800
|
+
~~~
|
801
|
+
|
802
|
+
### Parameters
|
803
|
+
|
804
|
+
Name | Type | Description | Notes
|
805
|
+
------------- | ------------- | ------------- | -------------
|
806
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25]
|
807
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1]
|
808
|
+
**filter_type** | **String**| Filter type | [optional] [default to PREFIX]
|
809
|
+
**name** | **String**| Name | [optional]
|
810
|
+
**sort_by** | **String**| Sort by | [optional]
|
811
|
+
**sort_order** | **String**| Sort order | [optional] [default to a]
|
812
|
+
{: class="table table-striped"}
|
813
|
+
|
814
|
+
|
815
|
+
### Return type
|
816
|
+
|
817
|
+
[**AttemptLimitsEntityListing**](AttemptLimitsEntityListing.html)
|
818
|
+
|
819
|
+
### HTTP request headers
|
820
|
+
|
821
|
+
- **Content-Type**: application/json
|
822
|
+
- **Accept**: application/json
|
823
|
+
|
824
|
+
|
825
|
+
|
826
|
+
<a name="get_attemptlimits_attemptlimits_id"></a>
|
827
|
+
|
828
|
+
## -[**AttemptLimits**](AttemptLimits.html) get_attemptlimits_attemptlimits_id(attempt_limits_id)
|
829
|
+
|
830
|
+
Get attempt limits
|
831
|
+
|
832
|
+
|
833
|
+
|
834
|
+
### Example
|
835
|
+
~~~ruby
|
836
|
+
# load the gem
|
837
|
+
require 'purecloud'
|
838
|
+
# setup authorization
|
839
|
+
@secret = ENV['PURECLOUD_SECRET']
|
840
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
841
|
+
environment = "mypurecloud.com"
|
842
|
+
|
843
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
844
|
+
|
845
|
+
PureCloud.configure do |config|
|
846
|
+
config.access_token = @authToken
|
847
|
+
end
|
848
|
+
|
849
|
+
api_instance = PureCloud::OutboundApi.new
|
850
|
+
|
851
|
+
attempt_limits_id = "attempt_limits_id_example" # String | Attempt limits ID
|
852
|
+
|
853
|
+
|
854
|
+
begin
|
855
|
+
#Get attempt limits
|
856
|
+
result = api_instance.get_attemptlimits_attemptlimits_id(attempt_limits_id)
|
857
|
+
p result
|
858
|
+
rescue PureCloud::ApiError => e
|
859
|
+
puts "Exception when calling OutboundApi->get_attemptlimits_attemptlimits_id: #{e}"
|
860
|
+
end
|
861
|
+
~~~
|
862
|
+
|
863
|
+
### Parameters
|
864
|
+
|
865
|
+
Name | Type | Description | Notes
|
866
|
+
------------- | ------------- | ------------- | -------------
|
867
|
+
**attempt_limits_id** | **String**| Attempt limits ID |
|
868
|
+
{: class="table table-striped"}
|
869
|
+
|
870
|
+
|
871
|
+
### Return type
|
872
|
+
|
873
|
+
[**AttemptLimits**](AttemptLimits.html)
|
874
|
+
|
875
|
+
### HTTP request headers
|
876
|
+
|
877
|
+
- **Content-Type**: application/json
|
878
|
+
- **Accept**: application/json
|
879
|
+
|
880
|
+
|
881
|
+
|
697
882
|
<a name="get_callabletimesets"></a>
|
698
883
|
|
699
884
|
## -[**CallableTimeSetEntityListing**](CallableTimeSetEntityListing.html) get_callabletimesets(opts)
|
@@ -1129,6 +1314,62 @@ Name | Type | Description | Notes
|
|
1129
1314
|
|
1130
1315
|
|
1131
1316
|
|
1317
|
+
<a name="get_campaigns_campaign_id_interactions"></a>
|
1318
|
+
|
1319
|
+
## -[**CampaignInteractions**](CampaignInteractions.html) get_campaigns_campaign_id_interactions(campaign_id)
|
1320
|
+
|
1321
|
+
Get dialer campaign interactions.
|
1322
|
+
|
1323
|
+
|
1324
|
+
|
1325
|
+
### Example
|
1326
|
+
~~~ruby
|
1327
|
+
# load the gem
|
1328
|
+
require 'purecloud'
|
1329
|
+
# setup authorization
|
1330
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1331
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1332
|
+
environment = "mypurecloud.com"
|
1333
|
+
|
1334
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1335
|
+
|
1336
|
+
PureCloud.configure do |config|
|
1337
|
+
config.access_token = @authToken
|
1338
|
+
end
|
1339
|
+
|
1340
|
+
api_instance = PureCloud::OutboundApi.new
|
1341
|
+
|
1342
|
+
campaign_id = "campaign_id_example" # String | Campaign ID
|
1343
|
+
|
1344
|
+
|
1345
|
+
begin
|
1346
|
+
#Get dialer campaign interactions.
|
1347
|
+
result = api_instance.get_campaigns_campaign_id_interactions(campaign_id)
|
1348
|
+
p result
|
1349
|
+
rescue PureCloud::ApiError => e
|
1350
|
+
puts "Exception when calling OutboundApi->get_campaigns_campaign_id_interactions: #{e}"
|
1351
|
+
end
|
1352
|
+
~~~
|
1353
|
+
|
1354
|
+
### Parameters
|
1355
|
+
|
1356
|
+
Name | Type | Description | Notes
|
1357
|
+
------------- | ------------- | ------------- | -------------
|
1358
|
+
**campaign_id** | **String**| Campaign ID |
|
1359
|
+
{: class="table table-striped"}
|
1360
|
+
|
1361
|
+
|
1362
|
+
### Return type
|
1363
|
+
|
1364
|
+
[**CampaignInteractions**](CampaignInteractions.html)
|
1365
|
+
|
1366
|
+
### HTTP request headers
|
1367
|
+
|
1368
|
+
- **Content-Type**: application/json
|
1369
|
+
- **Accept**: application/json
|
1370
|
+
|
1371
|
+
|
1372
|
+
|
1132
1373
|
<a name="get_campaigns_campaign_id_progress"></a>
|
1133
1374
|
|
1134
1375
|
## -[**CampaignProgress**](CampaignProgress.html) get_campaigns_campaign_id_progress(campaign_id)
|
@@ -2306,6 +2547,62 @@ This endpoint does not need any parameter.
|
|
2306
2547
|
|
2307
2548
|
|
2308
2549
|
|
2550
|
+
<a name="post_attemptlimits"></a>
|
2551
|
+
|
2552
|
+
## -[**AttemptLimits**](AttemptLimits.html) post_attemptlimits(body)
|
2553
|
+
|
2554
|
+
Create attempt limits
|
2555
|
+
|
2556
|
+
|
2557
|
+
|
2558
|
+
### Example
|
2559
|
+
~~~ruby
|
2560
|
+
# load the gem
|
2561
|
+
require 'purecloud'
|
2562
|
+
# setup authorization
|
2563
|
+
@secret = ENV['PURECLOUD_SECRET']
|
2564
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
2565
|
+
environment = "mypurecloud.com"
|
2566
|
+
|
2567
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
2568
|
+
|
2569
|
+
PureCloud.configure do |config|
|
2570
|
+
config.access_token = @authToken
|
2571
|
+
end
|
2572
|
+
|
2573
|
+
api_instance = PureCloud::OutboundApi.new
|
2574
|
+
|
2575
|
+
body = PureCloud::AttemptLimits.new # AttemptLimits | AttemptLimits
|
2576
|
+
|
2577
|
+
|
2578
|
+
begin
|
2579
|
+
#Create attempt limits
|
2580
|
+
result = api_instance.post_attemptlimits(body)
|
2581
|
+
p result
|
2582
|
+
rescue PureCloud::ApiError => e
|
2583
|
+
puts "Exception when calling OutboundApi->post_attemptlimits: #{e}"
|
2584
|
+
end
|
2585
|
+
~~~
|
2586
|
+
|
2587
|
+
### Parameters
|
2588
|
+
|
2589
|
+
Name | Type | Description | Notes
|
2590
|
+
------------- | ------------- | ------------- | -------------
|
2591
|
+
**body** | [**AttemptLimits**](AttemptLimits.html)| AttemptLimits |
|
2592
|
+
{: class="table table-striped"}
|
2593
|
+
|
2594
|
+
|
2595
|
+
### Return type
|
2596
|
+
|
2597
|
+
[**AttemptLimits**](AttemptLimits.html)
|
2598
|
+
|
2599
|
+
### HTTP request headers
|
2600
|
+
|
2601
|
+
- **Content-Type**: application/json
|
2602
|
+
- **Accept**: application/json
|
2603
|
+
|
2604
|
+
|
2605
|
+
|
2309
2606
|
<a name="post_audits"></a>
|
2310
2607
|
|
2311
2608
|
## -[**AuditSearchResult**](AuditSearchResult.html) post_audits(body, opts)
|
@@ -3169,6 +3466,65 @@ Name | Type | Description | Notes
|
|
3169
3466
|
|
3170
3467
|
|
3171
3468
|
|
3469
|
+
<a name="put_attemptlimits_attemptlimits_id"></a>
|
3470
|
+
|
3471
|
+
## -[**AttemptLimits**](AttemptLimits.html) put_attemptlimits_attemptlimits_id(attempt_limits_id, body)
|
3472
|
+
|
3473
|
+
Update attempt limits
|
3474
|
+
|
3475
|
+
|
3476
|
+
|
3477
|
+
### Example
|
3478
|
+
~~~ruby
|
3479
|
+
# load the gem
|
3480
|
+
require 'purecloud'
|
3481
|
+
# setup authorization
|
3482
|
+
@secret = ENV['PURECLOUD_SECRET']
|
3483
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
3484
|
+
environment = "mypurecloud.com"
|
3485
|
+
|
3486
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
3487
|
+
|
3488
|
+
PureCloud.configure do |config|
|
3489
|
+
config.access_token = @authToken
|
3490
|
+
end
|
3491
|
+
|
3492
|
+
api_instance = PureCloud::OutboundApi.new
|
3493
|
+
|
3494
|
+
attempt_limits_id = "attempt_limits_id_example" # String | Attempt limits ID
|
3495
|
+
|
3496
|
+
body = PureCloud::AttemptLimits.new # AttemptLimits | AttemptLimits
|
3497
|
+
|
3498
|
+
|
3499
|
+
begin
|
3500
|
+
#Update attempt limits
|
3501
|
+
result = api_instance.put_attemptlimits_attemptlimits_id(attempt_limits_id, body)
|
3502
|
+
p result
|
3503
|
+
rescue PureCloud::ApiError => e
|
3504
|
+
puts "Exception when calling OutboundApi->put_attemptlimits_attemptlimits_id: #{e}"
|
3505
|
+
end
|
3506
|
+
~~~
|
3507
|
+
|
3508
|
+
### Parameters
|
3509
|
+
|
3510
|
+
Name | Type | Description | Notes
|
3511
|
+
------------- | ------------- | ------------- | -------------
|
3512
|
+
**attempt_limits_id** | **String**| Attempt limits ID |
|
3513
|
+
**body** | [**AttemptLimits**](AttemptLimits.html)| AttemptLimits |
|
3514
|
+
{: class="table table-striped"}
|
3515
|
+
|
3516
|
+
|
3517
|
+
### Return type
|
3518
|
+
|
3519
|
+
[**AttemptLimits**](AttemptLimits.html)
|
3520
|
+
|
3521
|
+
### HTTP request headers
|
3522
|
+
|
3523
|
+
- **Content-Type**: application/json
|
3524
|
+
- **Accept**: application/json
|
3525
|
+
|
3526
|
+
|
3527
|
+
|
3172
3528
|
<a name="put_callabletimesets_callabletimeset_id"></a>
|
3173
3529
|
|
3174
3530
|
## -[**CallableTimeSet**](CallableTimeSet.html) put_callabletimesets_callabletimeset_id(callable_time_set_id, body)
|