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,16 @@
|
|
1
|
+
---
|
2
|
+
title: SocialConversationNotificationDetail
|
3
|
+
---
|
4
|
+
## PureCloud::SocialConversationNotificationDetail
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **error_code** | **String** | | [optional] |
|
11
|
+
| **field_name** | **String** | | [optional] |
|
12
|
+
| **entity_id** | **String** | | [optional] |
|
13
|
+
| **entity_name** | **String** | | [optional] |
|
14
|
+
{: class="table table-striped"}
|
15
|
+
|
16
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
---
|
2
|
+
title: SocialConversationNotificationErrorBody
|
3
|
+
---
|
4
|
+
## PureCloud::SocialConversationNotificationErrorBody
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **status** | **Integer** | | [optional] |
|
11
|
+
| **code** | **String** | | [optional] |
|
12
|
+
| **entity_id** | **String** | | [optional] |
|
13
|
+
| **entity_name** | **String** | | [optional] |
|
14
|
+
| **message** | **String** | | [optional] |
|
15
|
+
| **message_with_params** | **String** | | [optional] |
|
16
|
+
| **message_params** | **Hash<String, String>** | | [optional] |
|
17
|
+
| **context_id** | **String** | | [optional] |
|
18
|
+
| **details** | [**Array<CallbackConversationNotificationErrorInfoDetails>**](CallbackConversationNotificationErrorInfoDetails.html) | | [optional] |
|
19
|
+
| **errors** | [**Array<SocialConversationNotificationErrorBody>**](SocialConversationNotificationErrorBody.html) | | [optional] |
|
20
|
+
{: class="table table-striped"}
|
21
|
+
|
22
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
---
|
2
|
+
title: SocialConversationNotificationErrorInfo
|
3
|
+
---
|
4
|
+
## PureCloud::SocialConversationNotificationErrorInfo
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **message** | **String** | | [optional] |
|
11
|
+
| **context_id** | **String** | | [optional] |
|
12
|
+
| **errors** | [**Array<SocialConversationNotificationErrorBody>**](SocialConversationNotificationErrorBody.html) | | [optional] |
|
13
|
+
| **message_params** | **Hash<String, String>** | | [optional] |
|
14
|
+
| **details** | [**Array<CallbackConversationNotificationErrorInfoDetails>**](CallbackConversationNotificationErrorInfoDetails.html) | | [optional] |
|
15
|
+
| **status** | **Integer** | | [optional] |
|
16
|
+
| **message_with_params** | **String** | | [optional] |
|
17
|
+
| **entity_id** | **String** | | [optional] |
|
18
|
+
| **code** | **String** | | [optional] |
|
19
|
+
| **entity_name** | **String** | | [optional] |
|
20
|
+
{: class="table table-striped"}
|
21
|
+
|
22
|
+
|
@@ -0,0 +1,37 @@
|
|
1
|
+
---
|
2
|
+
title: SocialConversationNotificationParticipants
|
3
|
+
---
|
4
|
+
## PureCloud::SocialConversationNotificationParticipants
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **queue** | [**SocialConversationNotificationUriReference**](SocialConversationNotificationUriReference.html) | | [optional] |
|
11
|
+
| **held** | **BOOLEAN** | | [optional] |
|
12
|
+
| **social_media_id** | **String** | | [optional] |
|
13
|
+
| **error_info** | [**SocialConversationNotificationErrorInfo**](SocialConversationNotificationErrorInfo.html) | | [optional] |
|
14
|
+
| **connected_time** | **DateTime** | | [optional] |
|
15
|
+
| **social_user_name** | **String** | | [optional] |
|
16
|
+
| **wrapup_skipped** | **BOOLEAN** | | [optional] |
|
17
|
+
| **direction** | **String** | | [optional] |
|
18
|
+
| **wrapup_required** | **BOOLEAN** | | [optional] |
|
19
|
+
| **state** | **String** | | [optional] |
|
20
|
+
| **purpose** | **String** | | [optional] |
|
21
|
+
| **script** | [**SocialConversationNotificationUriReference**](SocialConversationNotificationUriReference.html) | | [optional] |
|
22
|
+
| **end_time** | **DateTime** | | [optional] |
|
23
|
+
| **social_media_hub** | **String** | | [optional] |
|
24
|
+
| **id** | **String** | | [optional] |
|
25
|
+
| **start_time** | **DateTime** | | [optional] |
|
26
|
+
| **disconnect_type** | **String** | | [optional] |
|
27
|
+
| **wrapup_prompt** | **String** | | [optional] |
|
28
|
+
| **address** | **String** | | [optional] |
|
29
|
+
| **name** | **String** | | [optional] |
|
30
|
+
| **start_hold_time** | **DateTime** | | [optional] |
|
31
|
+
| **wrapup_timeout_ms** | **Integer** | | [optional] |
|
32
|
+
| **attributes** | **Hash<String, String>** | | [optional] |
|
33
|
+
| **preview_text** | **String** | | [optional] |
|
34
|
+
| **user** | [**CallbackConversationNotificationUser**](CallbackConversationNotificationUser.html) | | [optional] |
|
35
|
+
{: class="table table-striped"}
|
36
|
+
|
37
|
+
|
@@ -0,0 +1,37 @@
|
|
1
|
+
---
|
2
|
+
title: SocialConversationNotificationSocialMediaParticipant
|
3
|
+
---
|
4
|
+
## PureCloud::SocialConversationNotificationSocialMediaParticipant
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **id** | **String** | | [optional] |
|
11
|
+
| **name** | **String** | | [optional] |
|
12
|
+
| **address** | **String** | | [optional] |
|
13
|
+
| **start_time** | **DateTime** | | [optional] |
|
14
|
+
| **connected_time** | **DateTime** | | [optional] |
|
15
|
+
| **end_time** | **DateTime** | | [optional] |
|
16
|
+
| **start_hold_time** | **DateTime** | | [optional] |
|
17
|
+
| **purpose** | **String** | | [optional] |
|
18
|
+
| **state** | **String** | | [optional] |
|
19
|
+
| **direction** | **String** | | [optional] |
|
20
|
+
| **disconnect_type** | **String** | | [optional] |
|
21
|
+
| **held** | **BOOLEAN** | | [optional] |
|
22
|
+
| **wrapup_required** | **BOOLEAN** | | [optional] |
|
23
|
+
| **wrapup_prompt** | **String** | | [optional] |
|
24
|
+
| **user** | [**CallbackConversationNotificationUser**](CallbackConversationNotificationUser.html) | | [optional] |
|
25
|
+
| **queue** | [**SocialConversationNotificationUriReference**](SocialConversationNotificationUriReference.html) | | [optional] |
|
26
|
+
| **attributes** | **Hash<String, String>** | | [optional] |
|
27
|
+
| **error_info** | [**SocialConversationNotificationErrorInfo**](SocialConversationNotificationErrorInfo.html) | | [optional] |
|
28
|
+
| **script** | [**SocialConversationNotificationUriReference**](SocialConversationNotificationUriReference.html) | | [optional] |
|
29
|
+
| **wrapup_timeout_ms** | **Integer** | | [optional] |
|
30
|
+
| **wrapup_skipped** | **BOOLEAN** | | [optional] |
|
31
|
+
| **social_media_id** | **String** | | [optional] |
|
32
|
+
| **social_media_hub** | **String** | | [optional] |
|
33
|
+
| **social_user_name** | **String** | | [optional] |
|
34
|
+
| **preview_text** | **String** | | [optional] |
|
35
|
+
{: class="table table-striped"}
|
36
|
+
|
37
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
---
|
2
|
+
title: SocialConversationNotificationUriReference
|
3
|
+
---
|
4
|
+
## PureCloud::SocialConversationNotificationUriReference
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **id** | **String** | | [optional] |
|
11
|
+
| **name** | **String** | | [optional] |
|
12
|
+
{: class="table table-striped"}
|
13
|
+
|
14
|
+
|
@@ -7,19 +7,19 @@ title: SocialExpression
|
|
7
7
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **state** | **String** |
|
11
|
-
| **id** | **String** |
|
12
|
-
| **social_media_id** | **String** |
|
13
|
-
| **social_media_hub** | **String** |
|
14
|
-
| **social_user_name** | **String** |
|
15
|
-
| **preview_text** | **String** |
|
16
|
-
| **recording_id** | **String** |
|
17
|
-
| **segments** | [**Array<Segment>**](Segment.html) |
|
18
|
-
| **held** | **BOOLEAN** |
|
19
|
-
| **disconnect_type** | **String** |
|
20
|
-
| **start_hold_time** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
21
|
-
| **connected_time** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
22
|
-
| **disconnected_time** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
10
|
+
| **state** | **String** | The connection state of this communication. | [optional] |
|
11
|
+
| **id** | **String** | A globally unique identifier for this communication. | [optional] |
|
12
|
+
| **social_media_id** | **String** | A globally unique identifier for the social media. | [optional] |
|
13
|
+
| **social_media_hub** | **String** | The social network of the communication | [optional] |
|
14
|
+
| **social_user_name** | **String** | The user name for the communication. | [optional] |
|
15
|
+
| **preview_text** | **String** | The text preview of the communication contents | [optional] |
|
16
|
+
| **recording_id** | **String** | A globally unique identifier for the recording associated with this chat. | [optional] |
|
17
|
+
| **segments** | [**Array<Segment>**](Segment.html) | The time line of the participant's chat, divided into activity segments. | [optional] |
|
18
|
+
| **held** | **BOOLEAN** | True if this call is held and the person on this side hears silence. | [optional] [default to false]|
|
19
|
+
| **disconnect_type** | **String** | System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. | [optional] |
|
20
|
+
| **start_hold_time** | **DateTime** | The timestamp the chat was placed on hold in the cloud clock if the chat is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
21
|
+
| **connected_time** | **DateTime** | The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
22
|
+
| **disconnected_time** | **DateTime** | The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
23
23
|
{: class="table table-striped"}
|
24
24
|
|
25
25
|
|
@@ -12,9 +12,9 @@ title: StationEntityListing
|
|
12
12
|
| **total** | **Integer** | | [optional] |
|
13
13
|
| **entities** | [**Array<Station>**](Station.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: StreetAddress
|
|
7
7
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **country** | **String** |
|
10
|
+
| **country** | **String** | 2 Letter Country code, like US or GB | |
|
11
11
|
| **a1** | **String** | | [optional] |
|
12
12
|
| **a3** | **String** | | [optional] |
|
13
13
|
| **rd** | **String** | | [optional] |
|
@@ -7,8 +7,8 @@ title: SubscriberResponse
|
|
7
7
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **message_returned** | **Array<String>** |
|
11
|
-
| **status** | **String** |
|
10
|
+
| **message_returned** | **Array<String>** | Suggested valid addresses | [optional] |
|
11
|
+
| **status** | **String** | http status | |
|
12
12
|
{: class="table table-striped"}
|
13
13
|
|
14
14
|
|
data/doc_out/SuggestApi.html.md
CHANGED
@@ -39,11 +39,11 @@ end
|
|
39
39
|
|
40
40
|
api_instance = PureCloud::SuggestApi.new
|
41
41
|
|
42
|
-
q64 = "q64_example" # String |
|
42
|
+
q64 = "q64_example" # String | q64
|
43
43
|
|
44
44
|
opts = {
|
45
|
-
expand: ["expand_example"], # Array<String> |
|
46
|
-
profile: true # BOOLEAN |
|
45
|
+
expand: ["expand_example"], # Array<String> | expand
|
46
|
+
profile: true # BOOLEAN | profile
|
47
47
|
}
|
48
48
|
|
49
49
|
begin
|
@@ -59,9 +59,9 @@ end
|
|
59
59
|
|
60
60
|
Name | Type | Description | Notes
|
61
61
|
------------- | ------------- | ------------- | -------------
|
62
|
-
**q64** | **String**|
|
63
|
-
**expand** | [**Array<String>**](String.html)|
|
64
|
-
**profile** | **BOOLEAN**|
|
62
|
+
**q64** | **String**| q64 |
|
63
|
+
**expand** | [**Array<String>**](String.html)| expand | [optional]
|
64
|
+
**profile** | **BOOLEAN**| profile | [optional] [default to true]
|
65
65
|
{: class="table table-striped"}
|
66
66
|
|
67
67
|
|
@@ -101,10 +101,10 @@ end
|
|
101
101
|
|
102
102
|
api_instance = PureCloud::SuggestApi.new
|
103
103
|
|
104
|
-
q64 = "q64_example" # String |
|
104
|
+
q64 = "q64_example" # String | q64
|
105
105
|
|
106
106
|
opts = {
|
107
|
-
profile: true # BOOLEAN |
|
107
|
+
profile: true # BOOLEAN | profile
|
108
108
|
}
|
109
109
|
|
110
110
|
begin
|
@@ -120,8 +120,8 @@ end
|
|
120
120
|
|
121
121
|
Name | Type | Description | Notes
|
122
122
|
------------- | ------------- | ------------- | -------------
|
123
|
-
**q64** | **String**|
|
124
|
-
**profile** | **BOOLEAN**|
|
123
|
+
**q64** | **String**| q64 |
|
124
|
+
**profile** | **BOOLEAN**| profile | [optional] [default to true]
|
125
125
|
{: class="table table-striped"}
|
126
126
|
|
127
127
|
|
@@ -164,7 +164,7 @@ api_instance = PureCloud::SuggestApi.new
|
|
164
164
|
body = PureCloud::SearchRequest.new # SearchRequest | Search request options
|
165
165
|
|
166
166
|
opts = {
|
167
|
-
profile: true # BOOLEAN |
|
167
|
+
profile: true # BOOLEAN | profile
|
168
168
|
}
|
169
169
|
|
170
170
|
begin
|
@@ -181,7 +181,7 @@ end
|
|
181
181
|
Name | Type | Description | Notes
|
182
182
|
------------- | ------------- | ------------- | -------------
|
183
183
|
**body** | [**SearchRequest**](SearchRequest.html)| Search request options |
|
184
|
-
**profile** | **BOOLEAN**|
|
184
|
+
**profile** | **BOOLEAN**| profile | [optional] [default to true]
|
185
185
|
{: class="table table-striped"}
|
186
186
|
|
187
187
|
|
@@ -224,7 +224,7 @@ api_instance = PureCloud::SuggestApi.new
|
|
224
224
|
body = PureCloud::SuggestSearchRequest.new # SuggestSearchRequest | Search request options
|
225
225
|
|
226
226
|
opts = {
|
227
|
-
profile: true # BOOLEAN |
|
227
|
+
profile: true # BOOLEAN | profile
|
228
228
|
}
|
229
229
|
|
230
230
|
begin
|
@@ -241,7 +241,7 @@ end
|
|
241
241
|
Name | Type | Description | Notes
|
242
242
|
------------- | ------------- | ------------- | -------------
|
243
243
|
**body** | [**SuggestSearchRequest**](SuggestSearchRequest.html)| Search request options |
|
244
|
-
**profile** | **BOOLEAN**|
|
244
|
+
**profile** | **BOOLEAN**| profile | [optional] [default to true]
|
245
245
|
{: class="table table-striped"}
|
246
246
|
|
247
247
|
|
data/doc_out/TagValue.html.md
CHANGED
@@ -8,7 +8,7 @@ title: TagValue
|
|
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 workspace tag name. | |
|
12
12
|
| **in_use** | **BOOLEAN** | | [optional] [default to false]|
|
13
13
|
| **acl** | **Array<String>** | | [optional] |
|
14
14
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
@@ -12,9 +12,9 @@ title: TagValueEntityListing
|
|
12
12
|
| **total** | **Integer** | | [optional] |
|
13
13
|
| **entities** | [**Array<TagValue>**](TagValue.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"}
|
@@ -37,6 +37,7 @@ Method | HTTP request | Description
|
|
37
37
|
|[**get_providers_edges_edge_id_logs_jobs_job_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_logs_jobs_job_id) | **GET** /api/v2/telephony/providers/edges/{edgeId}/logs/jobs/{jobId} | Get an Edge logs job.|
|
38
38
|
|[**get_providers_edges_edge_id_physicalinterfaces**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_physicalinterfaces) | **GET** /api/v2/telephony/providers/edges/{edgeId}/physicalinterfaces | Retrieve a list of all configured physical interfaces from a specific edge.|
|
39
39
|
|[**get_providers_edges_edge_id_physicalinterfaces_interface_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_physicalinterfaces_interface_id) | **GET** /api/v2/telephony/providers/edges/{edgeId}/physicalinterfaces/{interfaceId} | Get edge physical interface.|
|
40
|
+
|[**get_providers_edges_edge_id_setuppackage**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_setuppackage) | **GET** /api/v2/telephony/providers/edges/{edgeId}/setuppackage | Get the setup package for a locally deployed edge device. This is needed to complete the setup process for the virtual edge.|
|
40
41
|
|[**get_providers_edges_edge_id_softwareupdate**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_softwareupdate) | **GET** /api/v2/telephony/providers/edges/{edgeId}/softwareupdate | Gets software update status information about any edge.|
|
41
42
|
|[**get_providers_edges_edge_id_softwareversions**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_softwareversions) | **GET** /api/v2/telephony/providers/edges/{edgeId}/softwareversions | Gets all the available software versions for this edge.|
|
42
43
|
|[**get_providers_edges_edgegroups**](TelephonyProvidersEdgeApi.html#get_providers_edges_edgegroups) | **GET** /api/v2/telephony/providers/edges/edgegroups | Get the list of edge groups.|
|
@@ -80,7 +81,7 @@ Method | HTTP request | Description
|
|
80
81
|
|[**get_schemas_edges_vnext_schemacategory_schematype**](TelephonyProvidersEdgeApi.html#get_schemas_edges_vnext_schemacategory_schematype) | **GET** /api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType} | List schemas of a specific category|
|
81
82
|
|[**get_schemas_edges_vnext_schemacategory_schematype_schema_id**](TelephonyProvidersEdgeApi.html#get_schemas_edges_vnext_schemacategory_schematype_schema_id) | **GET** /api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType}/{schemaId} | Get a json schema|
|
82
83
|
|[**get_schemas_edges_vnext_schemacategory_schematype_schema_id_extensiontype_metadata_id**](TelephonyProvidersEdgeApi.html#get_schemas_edges_vnext_schemacategory_schematype_schema_id_extensiontype_metadata_id) | **GET** /api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType}/{schemaId}/{extensionType}/{metadataId} | Get metadata for a schema|
|
83
|
-
|[**post_providers_edges**](TelephonyProvidersEdgeApi.html#post_providers_edges) | **POST** /api/v2/telephony/providers/edges | Create
|
84
|
+
|[**post_providers_edges**](TelephonyProvidersEdgeApi.html#post_providers_edges) | **POST** /api/v2/telephony/providers/edges | Create an edge.|
|
84
85
|
|[**post_providers_edges_addressvalidation**](TelephonyProvidersEdgeApi.html#post_providers_edges_addressvalidation) | **POST** /api/v2/telephony/providers/edges/addressvalidation | Validates a street address|
|
85
86
|
|[**post_providers_edges_certificateauthorities**](TelephonyProvidersEdgeApi.html#post_providers_edges_certificateauthorities) | **POST** /api/v2/telephony/providers/edges/certificateauthorities | Create a certificate authority.|
|
86
87
|
|[**post_providers_edges_didpools**](TelephonyProvidersEdgeApi.html#post_providers_edges_didpools) | **POST** /api/v2/telephony/providers/edges/didpools | Create a new DID pool|
|
@@ -93,6 +94,7 @@ Method | HTTP request | Description
|
|
93
94
|
|[**post_providers_edges_edgegroups**](TelephonyProvidersEdgeApi.html#post_providers_edges_edgegroups) | **POST** /api/v2/telephony/providers/edges/edgegroups | Create an edge group.|
|
94
95
|
|[**post_providers_edges_endpoints**](TelephonyProvidersEdgeApi.html#post_providers_edges_endpoints) | **POST** /api/v2/telephony/providers/edges/endpoints | Create endpoint|
|
95
96
|
|[**post_providers_edges_extensionpools**](TelephonyProvidersEdgeApi.html#post_providers_edges_extensionpools) | **POST** /api/v2/telephony/providers/edges/extensionpools | Create a new extension pool|
|
97
|
+
|[**post_providers_edges_offlineconfiguration**](TelephonyProvidersEdgeApi.html#post_providers_edges_offlineconfiguration) | **POST** /api/v2/telephony/providers/edges/offlineconfiguration | Create a file that can be used to configure a hardware Edge's settings.|
|
96
98
|
|[**post_providers_edges_outboundroutes**](TelephonyProvidersEdgeApi.html#post_providers_edges_outboundroutes) | **POST** /api/v2/telephony/providers/edges/outboundroutes | Create outbound rule|
|
97
99
|
|[**post_providers_edges_phonebasesettings**](TelephonyProvidersEdgeApi.html#post_providers_edges_phonebasesettings) | **POST** /api/v2/telephony/providers/edges/phonebasesettings | Create a new Phone Base Settings object|
|
98
100
|
|[**post_providers_edges_phones**](TelephonyProvidersEdgeApi.html#post_providers_edges_phones) | **POST** /api/v2/telephony/providers/edges/phones | Create a new Phone|
|
@@ -1784,6 +1786,62 @@ Name | Type | Description | Notes
|
|
1784
1786
|
|
1785
1787
|
|
1786
1788
|
|
1789
|
+
<a name="get_providers_edges_edge_id_setuppackage"></a>
|
1790
|
+
|
1791
|
+
## -[**VmPairingInfo**](VmPairingInfo.html) get_providers_edges_edge_id_setuppackage(edge_id)
|
1792
|
+
|
1793
|
+
Get the setup package for a locally deployed edge device. This is needed to complete the setup process for the virtual edge.
|
1794
|
+
|
1795
|
+
|
1796
|
+
|
1797
|
+
### Example
|
1798
|
+
~~~ruby
|
1799
|
+
# load the gem
|
1800
|
+
require 'purecloud'
|
1801
|
+
# setup authorization
|
1802
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1803
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1804
|
+
environment = "mypurecloud.com"
|
1805
|
+
|
1806
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1807
|
+
|
1808
|
+
PureCloud.configure do |config|
|
1809
|
+
config.access_token = @authToken
|
1810
|
+
end
|
1811
|
+
|
1812
|
+
api_instance = PureCloud::TelephonyProvidersEdgeApi.new
|
1813
|
+
|
1814
|
+
edge_id = "edge_id_example" # String | Edge ID
|
1815
|
+
|
1816
|
+
|
1817
|
+
begin
|
1818
|
+
#Get the setup package for a locally deployed edge device. This is needed to complete the setup process for the virtual edge.
|
1819
|
+
result = api_instance.get_providers_edges_edge_id_setuppackage(edge_id)
|
1820
|
+
p result
|
1821
|
+
rescue PureCloud::ApiError => e
|
1822
|
+
puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_edge_id_setuppackage: #{e}"
|
1823
|
+
end
|
1824
|
+
~~~
|
1825
|
+
|
1826
|
+
### Parameters
|
1827
|
+
|
1828
|
+
Name | Type | Description | Notes
|
1829
|
+
------------- | ------------- | ------------- | -------------
|
1830
|
+
**edge_id** | **String**| Edge ID |
|
1831
|
+
{: class="table table-striped"}
|
1832
|
+
|
1833
|
+
|
1834
|
+
### Return type
|
1835
|
+
|
1836
|
+
[**VmPairingInfo**](VmPairingInfo.html)
|
1837
|
+
|
1838
|
+
### HTTP request headers
|
1839
|
+
|
1840
|
+
- **Content-Type**: application/json
|
1841
|
+
- **Accept**: application/json
|
1842
|
+
|
1843
|
+
|
1844
|
+
|
1787
1845
|
<a name="get_providers_edges_edge_id_softwareupdate"></a>
|
1788
1846
|
|
1789
1847
|
## -[**DomainEdgeSoftwareUpdateDto**](DomainEdgeSoftwareUpdateDto.html) get_providers_edges_edge_id_softwareupdate(edge_id)
|
@@ -1842,7 +1900,7 @@ Name | Type | Description | Notes
|
|
1842
1900
|
|
1843
1901
|
<a name="get_providers_edges_edge_id_softwareversions"></a>
|
1844
1902
|
|
1845
|
-
## -[**
|
1903
|
+
## -[**DomainEdgeSoftwareVersionDtoEntityListing**](DomainEdgeSoftwareVersionDtoEntityListing.html) get_providers_edges_edge_id_softwareversions(edge_id)
|
1846
1904
|
|
1847
1905
|
Gets all the available software versions for this edge.
|
1848
1906
|
|
@@ -1887,7 +1945,7 @@ Name | Type | Description | Notes
|
|
1887
1945
|
|
1888
1946
|
### Return type
|
1889
1947
|
|
1890
|
-
[**
|
1948
|
+
[**DomainEdgeSoftwareVersionDtoEntityListing**](DomainEdgeSoftwareVersionDtoEntityListing.html)
|
1891
1949
|
|
1892
1950
|
### HTTP request headers
|
1893
1951
|
|
@@ -4375,7 +4433,7 @@ Name | Type | Description | Notes
|
|
4375
4433
|
|
4376
4434
|
## -[**Edge**](Edge.html) post_providers_edges(body)
|
4377
4435
|
|
4378
|
-
Create
|
4436
|
+
Create an edge.
|
4379
4437
|
|
4380
4438
|
|
4381
4439
|
|
@@ -4400,7 +4458,7 @@ body = PureCloud::Edge.new # Edge | Edge
|
|
4400
4458
|
|
4401
4459
|
|
4402
4460
|
begin
|
4403
|
-
#Create
|
4461
|
+
#Create an edge.
|
4404
4462
|
result = api_instance.post_providers_edges(body)
|
4405
4463
|
p result
|
4406
4464
|
rescue PureCloud::ApiError => e
|
@@ -5059,7 +5117,7 @@ Name | Type | Description | Notes
|
|
5059
5117
|
|
5060
5118
|
<a name="post_providers_edges_extensionpools"></a>
|
5061
5119
|
|
5062
|
-
## -[**
|
5120
|
+
## -[**ExtensionPool**](ExtensionPool.html) post_providers_edges_extensionpools(body)
|
5063
5121
|
|
5064
5122
|
Create a new extension pool
|
5065
5123
|
|
@@ -5104,7 +5162,63 @@ Name | Type | Description | Notes
|
|
5104
5162
|
|
5105
5163
|
### Return type
|
5106
5164
|
|
5107
|
-
[**
|
5165
|
+
[**ExtensionPool**](ExtensionPool.html)
|
5166
|
+
|
5167
|
+
### HTTP request headers
|
5168
|
+
|
5169
|
+
- **Content-Type**: application/json
|
5170
|
+
- **Accept**: application/json
|
5171
|
+
|
5172
|
+
|
5173
|
+
|
5174
|
+
<a name="post_providers_edges_offlineconfiguration"></a>
|
5175
|
+
|
5176
|
+
## -[**EdgeOfflineConfigurationResponse**](EdgeOfflineConfigurationResponse.html) post_providers_edges_offlineconfiguration(body)
|
5177
|
+
|
5178
|
+
Create a file that can be used to configure a hardware Edge's settings.
|
5179
|
+
|
5180
|
+
|
5181
|
+
|
5182
|
+
### Example
|
5183
|
+
~~~ruby
|
5184
|
+
# load the gem
|
5185
|
+
require 'purecloud'
|
5186
|
+
# setup authorization
|
5187
|
+
@secret = ENV['PURECLOUD_SECRET']
|
5188
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
5189
|
+
environment = "mypurecloud.com"
|
5190
|
+
|
5191
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
5192
|
+
|
5193
|
+
PureCloud.configure do |config|
|
5194
|
+
config.access_token = @authToken
|
5195
|
+
end
|
5196
|
+
|
5197
|
+
api_instance = PureCloud::TelephonyProvidersEdgeApi.new
|
5198
|
+
|
5199
|
+
body = PureCloud::EdgeOfflineConfiguration.new # EdgeOfflineConfiguration | EdgeOfflineConfiguration
|
5200
|
+
|
5201
|
+
|
5202
|
+
begin
|
5203
|
+
#Create a file that can be used to configure a hardware Edge's settings.
|
5204
|
+
result = api_instance.post_providers_edges_offlineconfiguration(body)
|
5205
|
+
p result
|
5206
|
+
rescue PureCloud::ApiError => e
|
5207
|
+
puts "Exception when calling TelephonyProvidersEdgeApi->post_providers_edges_offlineconfiguration: #{e}"
|
5208
|
+
end
|
5209
|
+
~~~
|
5210
|
+
|
5211
|
+
### Parameters
|
5212
|
+
|
5213
|
+
Name | Type | Description | Notes
|
5214
|
+
------------- | ------------- | ------------- | -------------
|
5215
|
+
**body** | [**EdgeOfflineConfiguration**](EdgeOfflineConfiguration.html)| EdgeOfflineConfiguration |
|
5216
|
+
{: class="table table-striped"}
|
5217
|
+
|
5218
|
+
|
5219
|
+
### Return type
|
5220
|
+
|
5221
|
+
[**EdgeOfflineConfigurationResponse**](EdgeOfflineConfigurationResponse.html)
|
5108
5222
|
|
5109
5223
|
### HTTP request headers
|
5110
5224
|
|