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
data/doc_out/Group.html.md
CHANGED
|
@@ -8,7 +8,7 @@ title: Group
|
|
|
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 group name. | |
|
|
12
12
|
| **description** | **String** | | [optional] |
|
|
13
13
|
| **date_modified** | **DateTime** | Last modified date/time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
14
14
|
| **member_count** | **Integer** | Number of members. | [optional] |
|
|
@@ -12,9 +12,9 @@ title: GroupEntityListing
|
|
|
12
12
|
| **total** | **Integer** | | [optional] |
|
|
13
13
|
| **entities** | [**Array<Group>**](Group.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,8 +7,8 @@ title: GroupMembersUpdate
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **member_ids** | **Array<String>** |
|
|
11
|
-
| **version** | **Integer** |
|
|
10
|
+
| **member_ids** | **Array<String>** | A list of the ids of the members to add. | |
|
|
11
|
+
| **version** | **Integer** | The current group version. | |
|
|
12
12
|
{: class="table table-striped"}
|
|
13
13
|
|
|
14
14
|
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: GroupUpdate
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::GroupUpdate
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
|
+
| **name** | **String** | The group name. | [optional] |
|
|
12
|
+
| **description** | **String** | | [optional] |
|
|
13
|
+
| **state** | **String** | State of the group. | [optional] |
|
|
14
|
+
| **version** | **Integer** | Current version for this resource. | |
|
|
15
|
+
| **images** | [**Array<UserImage>**](UserImage.html) | | [optional] |
|
|
16
|
+
| **addresses** | [**Array<Contact>**](Contact.html) | | [optional] |
|
|
17
|
+
| **rules_visible** | **BOOLEAN** | Are membership rules visible to the person requesting to view the group | [optional] [default to false]|
|
|
18
|
+
| **visibility** | **String** | Who can view this group | [optional] |
|
|
19
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
20
|
+
{: class="table table-striped"}
|
|
21
|
+
|
|
22
|
+
|
data/doc_out/GroupsApi.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_group_id**](GroupsApi.html#delete_group_id) | **DELETE** /api/v2/groups/{groupId} | Delete group|
|
|
11
12
|
|[**delete_group_id_members**](GroupsApi.html#delete_group_id_members) | **DELETE** /api/v2/groups/{groupId}/members | Remove members|
|
|
12
13
|
|[**get_group_id**](GroupsApi.html#get_group_id) | **GET** /api/v2/groups/{groupId} | Get group|
|
|
13
14
|
|[**get_group_id_members**](GroupsApi.html#get_group_id_members) | **GET** /api/v2/groups/{groupId}/members | Get group members|
|
|
@@ -16,8 +17,65 @@ Method | HTTP request | Description
|
|
|
16
17
|
|[**post_group_id_members**](GroupsApi.html#post_group_id_members) | **POST** /api/v2/groups/{groupId}/members | Add members|
|
|
17
18
|
|[**post_groups**](GroupsApi.html#post_groups) | **POST** /api/v2/groups | Create a group|
|
|
18
19
|
|[**post_search**](GroupsApi.html#post_search) | **POST** /api/v2/groups/search | Search|
|
|
20
|
+
|[**put_group_id**](GroupsApi.html#put_group_id) | **PUT** /api/v2/groups/{groupId} | Update group|
|
|
19
21
|
{: class="table table-striped"}
|
|
20
22
|
|
|
23
|
+
<a name="delete_group_id"></a>
|
|
24
|
+
|
|
25
|
+
## -String** delete_group_id(group_id)
|
|
26
|
+
|
|
27
|
+
Delete group
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
### Example
|
|
32
|
+
~~~ruby
|
|
33
|
+
# load the gem
|
|
34
|
+
require 'purecloud'
|
|
35
|
+
# setup authorization
|
|
36
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
37
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
38
|
+
environment = "mypurecloud.com"
|
|
39
|
+
|
|
40
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
41
|
+
|
|
42
|
+
PureCloud.configure do |config|
|
|
43
|
+
config.access_token = @authToken
|
|
44
|
+
end
|
|
45
|
+
|
|
46
|
+
api_instance = PureCloud::GroupsApi.new
|
|
47
|
+
|
|
48
|
+
group_id = "group_id_example" # String | Group ID
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
begin
|
|
52
|
+
#Delete group
|
|
53
|
+
result = api_instance.delete_group_id(group_id)
|
|
54
|
+
p result
|
|
55
|
+
rescue PureCloud::ApiError => e
|
|
56
|
+
puts "Exception when calling GroupsApi->delete_group_id: #{e}"
|
|
57
|
+
end
|
|
58
|
+
~~~
|
|
59
|
+
|
|
60
|
+
### Parameters
|
|
61
|
+
|
|
62
|
+
Name | Type | Description | Notes
|
|
63
|
+
------------- | ------------- | ------------- | -------------
|
|
64
|
+
**group_id** | **String**| Group ID |
|
|
65
|
+
{: class="table table-striped"}
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
### Return type
|
|
69
|
+
|
|
70
|
+
**String**
|
|
71
|
+
|
|
72
|
+
### HTTP request headers
|
|
73
|
+
|
|
74
|
+
- **Content-Type**: application/json
|
|
75
|
+
- **Accept**: application/json
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
|
|
21
79
|
<a name="delete_group_id_members"></a>
|
|
22
80
|
|
|
23
81
|
## - delete_group_id_members(group_id, ids)
|
|
@@ -282,10 +340,10 @@ end
|
|
|
282
340
|
|
|
283
341
|
api_instance = PureCloud::GroupsApi.new
|
|
284
342
|
|
|
285
|
-
q64 = "q64_example" # String |
|
|
343
|
+
q64 = "q64_example" # String | q64
|
|
286
344
|
|
|
287
345
|
opts = {
|
|
288
|
-
expand: ["expand_example"] # Array<String> |
|
|
346
|
+
expand: ["expand_example"] # Array<String> | expand
|
|
289
347
|
}
|
|
290
348
|
|
|
291
349
|
begin
|
|
@@ -301,8 +359,8 @@ end
|
|
|
301
359
|
|
|
302
360
|
Name | Type | Description | Notes
|
|
303
361
|
------------- | ------------- | ------------- | -------------
|
|
304
|
-
**q64** | **String**|
|
|
305
|
-
**expand** | [**Array<String>**](String.html)|
|
|
362
|
+
**q64** | **String**| q64 |
|
|
363
|
+
**expand** | [**Array<String>**](String.html)| expand | [optional]
|
|
306
364
|
{: class="table table-striped"}
|
|
307
365
|
|
|
308
366
|
|
|
@@ -487,3 +545,63 @@ Name | Type | Description | Notes
|
|
|
487
545
|
|
|
488
546
|
|
|
489
547
|
|
|
548
|
+
<a name="put_group_id"></a>
|
|
549
|
+
|
|
550
|
+
## -[**Group**](Group.html) put_group_id(group_id, opts)
|
|
551
|
+
|
|
552
|
+
Update group
|
|
553
|
+
|
|
554
|
+
|
|
555
|
+
|
|
556
|
+
### Example
|
|
557
|
+
~~~ruby
|
|
558
|
+
# load the gem
|
|
559
|
+
require 'purecloud'
|
|
560
|
+
# setup authorization
|
|
561
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
562
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
563
|
+
environment = "mypurecloud.com"
|
|
564
|
+
|
|
565
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
566
|
+
|
|
567
|
+
PureCloud.configure do |config|
|
|
568
|
+
config.access_token = @authToken
|
|
569
|
+
end
|
|
570
|
+
|
|
571
|
+
api_instance = PureCloud::GroupsApi.new
|
|
572
|
+
|
|
573
|
+
group_id = "group_id_example" # String | Group ID
|
|
574
|
+
|
|
575
|
+
opts = {
|
|
576
|
+
body: PureCloud::GroupUpdate.new # GroupUpdate | Group
|
|
577
|
+
}
|
|
578
|
+
|
|
579
|
+
begin
|
|
580
|
+
#Update group
|
|
581
|
+
result = api_instance.put_group_id(group_id, opts)
|
|
582
|
+
p result
|
|
583
|
+
rescue PureCloud::ApiError => e
|
|
584
|
+
puts "Exception when calling GroupsApi->put_group_id: #{e}"
|
|
585
|
+
end
|
|
586
|
+
~~~
|
|
587
|
+
|
|
588
|
+
### Parameters
|
|
589
|
+
|
|
590
|
+
Name | Type | Description | Notes
|
|
591
|
+
------------- | ------------- | ------------- | -------------
|
|
592
|
+
**group_id** | **String**| Group ID |
|
|
593
|
+
**body** | [**GroupUpdate**](GroupUpdate.html)| Group | [optional]
|
|
594
|
+
{: class="table table-striped"}
|
|
595
|
+
|
|
596
|
+
|
|
597
|
+
### Return type
|
|
598
|
+
|
|
599
|
+
[**Group**](Group.html)
|
|
600
|
+
|
|
601
|
+
### HTTP request headers
|
|
602
|
+
|
|
603
|
+
- **Content-Type**: application/json
|
|
604
|
+
- **Accept**: application/json
|
|
605
|
+
|
|
606
|
+
|
|
607
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: HeartBeatAlert
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::HeartBeatAlert
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
|
+
| **name** | **String** | Name of the rule | |
|
|
12
|
+
| **sender_id** | **String** | The value that identifies the sender of the heartbeat. | |
|
|
13
|
+
| **heart_beat_timeout_in_minutes** | **Integer** | The number of minutes to wait before alerting missing heartbeats. | |
|
|
14
|
+
| **rule_id** | **String** | The id of the rule. | |
|
|
15
|
+
| **start_date** | **DateTime** | The date/time the alert was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | |
|
|
16
|
+
| **end_date** | **DateTime** | The date/time the owning rule exiting in alarm status. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
17
|
+
| **notification_users** | [**Array<User>**](User.html) | The ids of users who were notified of alarm state change. | |
|
|
18
|
+
| **alert_types** | **Array<String>** | A collection of notification methods. = ['SMS', 'DEVICE', 'EMAIL'] | |
|
|
19
|
+
| **rule_type** | **String** | The type of heartbeat rule that generated the alert | |
|
|
20
|
+
| **rule_uri** | **String** | | [optional] |
|
|
21
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
22
|
+
{: class="table table-striped"}
|
|
23
|
+
|
|
24
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: HeartBeatAlertContainer
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::HeartBeatAlertContainer
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **page_size** | **Integer** | | [optional] |
|
|
11
|
+
| **page_number** | **Integer** | | [optional] |
|
|
12
|
+
| **total** | **Integer** | | [optional] |
|
|
13
|
+
| **entities** | [**Array<HeartBeatAlert>**](HeartBeatAlert.html) | | [optional] |
|
|
14
|
+
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
|
+
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **first_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
|
+
| **page_count** | **Integer** | | [optional] |
|
|
20
|
+
{: class="table table-striped"}
|
|
21
|
+
|
|
22
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: HeartBeatAlertNotification
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::HeartBeatAlertNotification
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **id** | **String** | | [optional] |
|
|
11
|
+
| **name** | **String** | | [optional] |
|
|
12
|
+
| **sender_id** | **String** | | [optional] |
|
|
13
|
+
| **heart_beat_timeout_in_minutes** | **Float** | | [optional] |
|
|
14
|
+
| **rule_id** | **String** | | [optional] |
|
|
15
|
+
| **start_date** | **DateTime** | | [optional] |
|
|
16
|
+
| **end_date** | **DateTime** | | [optional] |
|
|
17
|
+
| **notification_users** | [**Array<HeartBeatAlertNotificationNotificationUsers>**](HeartBeatAlertNotificationNotificationUsers.html) | | [optional] |
|
|
18
|
+
| **alert_types** | **Array<String>** | | [optional] |
|
|
19
|
+
| **rule_type** | **String** | | [optional] |
|
|
20
|
+
{: class="table table-striped"}
|
|
21
|
+
|
|
22
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: HeartBeatAlertNotificationNotificationUser
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::HeartBeatAlertNotificationNotificationUser
|
|
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,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: HeartBeatAlertNotificationNotificationUsers
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::HeartBeatAlertNotificationNotificationUsers
|
|
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,22 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: HeartBeatRule
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::HeartBeatRule
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
|
+
| **name** | **String** | Name of the rule | |
|
|
12
|
+
| **sender_id** | **String** | The value that identifies the sender of the heartbeat. | |
|
|
13
|
+
| **heart_beat_timeout_in_minutes** | **Integer** | The number of minutes to wait before alerting missing heartbeats. | |
|
|
14
|
+
| **enabled** | **BOOLEAN** | Indicates if the rule is enabled. | [default to false]|
|
|
15
|
+
| **in_alarm** | **BOOLEAN** | Indicates if the rule is in alarm state. | [optional] [default to false]|
|
|
16
|
+
| **notification_users** | [**Array<User>**](User.html) | The ids of users who will be notified of alarm state change. | |
|
|
17
|
+
| **alert_types** | **Array<String>** | A collection of notification methods. = ['SMS', 'DEVICE', 'EMAIL']. | |
|
|
18
|
+
| **rule_type** | **String** | The type of system the will be generating the heartbeat. | |
|
|
19
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
20
|
+
{: class="table table-striped"}
|
|
21
|
+
|
|
22
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: HeartBeatRuleContainer
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::HeartBeatRuleContainer
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **page_size** | **Integer** | | [optional] |
|
|
11
|
+
| **page_number** | **Integer** | | [optional] |
|
|
12
|
+
| **total** | **Integer** | | [optional] |
|
|
13
|
+
| **entities** | [**Array<HeartBeatRule>**](HeartBeatRule.html) | | [optional] |
|
|
14
|
+
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
|
+
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **first_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
|
+
| **page_count** | **Integer** | | [optional] |
|
|
20
|
+
{: class="table table-striped"}
|
|
21
|
+
|
|
22
|
+
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: HeartBeatRuleNotification
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::HeartBeatRuleNotification
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **id** | **String** | | [optional] |
|
|
11
|
+
| **name** | **String** | | [optional] |
|
|
12
|
+
| **sender_id** | **String** | | [optional] |
|
|
13
|
+
| **heart_beat_timeout_in_minutes** | **Float** | | [optional] |
|
|
14
|
+
| **enabled** | **BOOLEAN** | | [optional] |
|
|
15
|
+
| **in_alarm** | **BOOLEAN** | | [optional] |
|
|
16
|
+
| **notification_users** | [**Array<HeartBeatAlertNotificationNotificationUsers>**](HeartBeatAlertNotificationNotificationUsers.html) | | [optional] |
|
|
17
|
+
| **alert_types** | **Array<String>** | | [optional] |
|
|
18
|
+
| **rule_type** | **String** | | [optional] |
|
|
19
|
+
{: class="table table-striped"}
|
|
20
|
+
|
|
21
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: HeartBeatRuleNotificationNotificationUser
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::HeartBeatRuleNotificationNotificationUser
|
|
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: InboundDomainEntityListing
|
|
|
12
12
|
| **total** | **Integer** | | [optional] |
|
|
13
13
|
| **entities** | [**Array<InboundDomain>**](InboundDomain.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,13 +9,13 @@ title: InboundRoute
|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
10
|
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
11
|
| **name** | **String** | | [optional] |
|
|
12
|
-
| **pattern** | **String** | The search pattern that the mailbox name should match. |
|
|
12
|
+
| **pattern** | **String** | The search pattern that the mailbox name should match. | |
|
|
13
13
|
| **queue** | [**UriReference**](UriReference.html) | The queue to route the emails to. | [optional] |
|
|
14
14
|
| **priority** | **Integer** | The priority to use for routing. | [optional] |
|
|
15
15
|
| **skills** | [**Array<UriReference>**](UriReference.html) | The skills to use for routing. | [optional] |
|
|
16
16
|
| **language** | [**UriReference**](UriReference.html) | The language to use for routing. | [optional] |
|
|
17
|
-
| **from_name** | **String** | The sender name to use for outgoing replies. |
|
|
18
|
-
| **from_email** | **String** | The sender email to use for outgoing replies. |
|
|
17
|
+
| **from_name** | **String** | The sender name to use for outgoing replies. | |
|
|
18
|
+
| **from_email** | **String** | The sender email to use for outgoing replies. | |
|
|
19
19
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -12,9 +12,9 @@ title: InboundRouteEntityListing
|
|
|
12
12
|
| **total** | **Integer** | | [optional] |
|
|
13
13
|
| **entities** | [**Array<InboundRoute>**](InboundRoute.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"}
|