purecloudplatformclientv2 2.0.6
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/README.md +56 -0
- data/docs/ADFS.md +20 -0
- data/docs/Actions.md +13 -0
- data/docs/ActivityCode.md +20 -0
- data/docs/ActivityCodeContainer.md +13 -0
- data/docs/AcwSettings.md +14 -0
- data/docs/Address.md +17 -0
- data/docs/AddressableEntityUser.md +14 -0
- data/docs/AddressableLicenseDefinition.md +14 -0
- data/docs/Adjacents.md +15 -0
- data/docs/Agent.md +13 -0
- data/docs/AgentActivity.md +19 -0
- data/docs/AgentActivityEntityListing.md +22 -0
- data/docs/AgentEvaluatorActivity.md +19 -0
- data/docs/AggregateDataContainer.md +14 -0
- data/docs/AggregateMetricData.md +15 -0
- data/docs/AggregateQueryResponse.md +13 -0
- data/docs/AggregateViewData.md +14 -0
- data/docs/AggregationQuery.md +20 -0
- data/docs/AggregationRange.md +14 -0
- data/docs/AggregationResult.md +17 -0
- data/docs/AggregationResultEntry.md +16 -0
- data/docs/AlertingApi.md +2129 -0
- data/docs/AnalyticsApi.md +1347 -0
- data/docs/AnalyticsConversation.md +17 -0
- data/docs/AnalyticsConversationQueryResponse.md +14 -0
- data/docs/AnalyticsConversationSegment.md +36 -0
- data/docs/AnalyticsEvaluation.md +22 -0
- data/docs/AnalyticsParticipant.md +19 -0
- data/docs/AnalyticsProperty.md +15 -0
- data/docs/AnalyticsQueryAggregation.md +17 -0
- data/docs/AnalyticsQueryClause.md +14 -0
- data/docs/AnalyticsQueryFilter.md +15 -0
- data/docs/AnalyticsQueryPredicate.md +20 -0
- data/docs/AnalyticsRoutingStatusRecord.md +16 -0
- data/docs/AnalyticsSession.md +44 -0
- data/docs/AnalyticsUserDetail.md +15 -0
- data/docs/AnalyticsUserDetailsQueryResponse.md +14 -0
- data/docs/AnalyticsUserPresenceRecord.md +17 -0
- data/docs/AnalyticsView.md +16 -0
- data/docs/Annotation.md +30 -0
- data/docs/AnswerOption.md +15 -0
- data/docs/ArchitectApi.md +2924 -0
- data/docs/ArchiveRetention.md +14 -0
- data/docs/Attachment.md +17 -0
- data/docs/AttemptLimits.md +22 -0
- data/docs/AttemptLimitsEntityListing.md +22 -0
- data/docs/AttemptLimitsNotification.md +24 -0
- data/docs/AttemptLimitsNotificationRecallEntries.md +15 -0
- data/docs/AttemptLimitsNotificationRecallEntry.md +15 -0
- data/docs/Attribute.md +21 -0
- data/docs/AttributeEntityListing.md +22 -0
- data/docs/AttributeFilterItem.md +15 -0
- data/docs/AttributeQueryRequest.md +15 -0
- data/docs/AttributesApi.md +377 -0
- data/docs/AuditChange.md +16 -0
- data/docs/AuditEntity.md +16 -0
- data/docs/AuditEntityReference.md +17 -0
- data/docs/AuditFacet.md +14 -0
- data/docs/AuditFilter.md +16 -0
- data/docs/AuditMessage.md +28 -0
- data/docs/AuditSearchResult.md +18 -0
- data/docs/AuditUser.md +15 -0
- data/docs/AuthorizationApi.md +1067 -0
- data/docs/AvailableLanguageList.md +13 -0
- data/docs/AvailableTopic.md +16 -0
- data/docs/AvailableTopicEntityListing.md +13 -0
- data/docs/AvailableTranslations.md +14 -0
- data/docs/Bullseye.md +13 -0
- data/docs/Calibration.md +28 -0
- data/docs/CalibrationAssignment.md +16 -0
- data/docs/CalibrationCreate.md +28 -0
- data/docs/CalibrationEntityListing.md +22 -0
- data/docs/Call.md +31 -0
- data/docs/CallBasic.md +31 -0
- data/docs/CallCommand.md +13 -0
- data/docs/CallConversation.md +18 -0
- data/docs/CallConversationEntityListing.md +22 -0
- data/docs/CallConversationNotification.md +17 -0
- data/docs/CallConversationNotificationCallMediaParticipant.md +48 -0
- data/docs/CallConversationNotificationDetail.md +16 -0
- data/docs/CallConversationNotificationErrorBody.md +22 -0
- data/docs/CallConversationNotificationErrorInfo.md +22 -0
- data/docs/CallConversationNotificationFaxStatus.md +20 -0
- data/docs/CallConversationNotificationParticipants.md +48 -0
- data/docs/CallConversationNotificationUriReference.md +14 -0
- data/docs/CallConversationNotificationWrapup.md +18 -0
- data/docs/CallForwarding.md +19 -0
- data/docs/CallMediaParticipant.md +48 -0
- data/docs/CallMediaPolicy.md +14 -0
- data/docs/CallMediaPolicyConditions.md +19 -0
- data/docs/CallRecord.md +14 -0
- data/docs/CallableContactsDiagnostic.md +16 -0
- data/docs/CallableTime.md +14 -0
- data/docs/CallableTimeSet.md +19 -0
- data/docs/CallableTimeSetEntityListing.md +22 -0
- data/docs/CallableTimeSetNotification.md +19 -0
- data/docs/CallableTimeSetNotificationCallableTime.md +15 -0
- data/docs/CallableTimeSetNotificationCallableTimes.md +15 -0
- data/docs/CallableTimeSetNotificationTimeSlot.md +16 -0
- data/docs/CallableTimeSetNotificationTimeSlots.md +16 -0
- data/docs/Callback.md +30 -0
- data/docs/CallbackBasic.md +30 -0
- data/docs/CallbackConversation.md +17 -0
- data/docs/CallbackConversationEntityListing.md +22 -0
- data/docs/CallbackConversationNotification.md +16 -0
- data/docs/CallbackConversationNotificationCallbackMediaParticipant.md +44 -0
- data/docs/CallbackConversationNotificationDetail.md +16 -0
- data/docs/CallbackConversationNotificationDialerPreview.md +18 -0
- data/docs/CallbackConversationNotificationErrorBody.md +22 -0
- data/docs/CallbackConversationNotificationErrorInfo.md +22 -0
- data/docs/CallbackConversationNotificationErrorInfoDetails.md +16 -0
- data/docs/CallbackConversationNotificationParticipants.md +44 -0
- data/docs/CallbackConversationNotificationPhoneNumberColumn.md +15 -0
- data/docs/CallbackConversationNotificationUriReference.md +14 -0
- data/docs/CallbackConversationNotificationWrapup.md +18 -0
- data/docs/CallbackIdentifier.md +14 -0
- data/docs/CallbackMediaParticipant.md +44 -0
- data/docs/Campaign.md +41 -0
- data/docs/CampaignDiagnostics.md +16 -0
- data/docs/CampaignEntityListing.md +22 -0
- data/docs/CampaignInteraction.md +33 -0
- data/docs/CampaignInteractions.md +18 -0
- data/docs/CampaignNotification.md +43 -0
- data/docs/CampaignNotificationContactSort.md +16 -0
- data/docs/CampaignNotificationErrors.md +15 -0
- data/docs/CampaignNotificationPhoneColumn.md +15 -0
- data/docs/CampaignNotificationPhoneColumns.md +15 -0
- data/docs/CampaignNotificationRestErrorDetail.md +15 -0
- data/docs/CampaignNotificationUriReference.md +14 -0
- data/docs/CampaignProgress.md +17 -0
- data/docs/CampaignProgressNotification.md +17 -0
- data/docs/CampaignProgressNotificationUriReference.md +14 -0
- data/docs/CampaignRule.md +23 -0
- data/docs/CampaignRuleAction.md +16 -0
- data/docs/CampaignRuleActionEntities.md +15 -0
- data/docs/CampaignRuleCondition.md +15 -0
- data/docs/CampaignRuleEntities.md +14 -0
- data/docs/CampaignRuleEntityListing.md +22 -0
- data/docs/CampaignRuleNotification.md +23 -0
- data/docs/CampaignRuleNotificationCampaignRuleAction.md +17 -0
- data/docs/CampaignRuleNotificationCampaignRuleActionEntities.md +16 -0
- data/docs/CampaignRuleNotificationCampaignRuleActions.md +17 -0
- data/docs/CampaignRuleNotificationCampaignRuleCondition.md +16 -0
- data/docs/CampaignRuleNotificationCampaignRuleConditions.md +16 -0
- data/docs/CampaignRuleNotificationCampaignRuleEntities.md +14 -0
- data/docs/CampaignRuleNotificationUriReference.md +14 -0
- data/docs/CampaignRuleParameters.md +16 -0
- data/docs/CampaignSchedule.md +21 -0
- data/docs/CampaignScheduleNotification.md +21 -0
- data/docs/CampaignScheduleNotificationIntervals.md +15 -0
- data/docs/CampaignScheduleNotificationScheduleInterval.md +15 -0
- data/docs/CampaignScheduleNotificationUriReference.md +14 -0
- data/docs/CampaignSequence.md +23 -0
- data/docs/CampaignSequenceEntityListing.md +22 -0
- data/docs/CampaignSequenceNotification.md +23 -0
- data/docs/CampaignSequenceNotificationUriReference.md +14 -0
- data/docs/CampaignStats.md +18 -0
- data/docs/CampaignTimeSlot.md +15 -0
- data/docs/Certificate.md +13 -0
- data/docs/CertificateAuthorityEntityListing.md +22 -0
- data/docs/CertificateDetails.md +19 -0
- data/docs/Change.md +16 -0
- data/docs/Channel.md +14 -0
- data/docs/ChannelEntityListing.md +13 -0
- data/docs/ChannelTopic.md +14 -0
- data/docs/ChannelTopicEntityListing.md +13 -0
- data/docs/Chat.md +13 -0
- data/docs/ChatConversation.md +17 -0
- data/docs/ChatConversationEntityListing.md +22 -0
- data/docs/ChatConversationNotification.md +16 -0
- data/docs/ChatConversationNotificationChatMediaParticipant.md +38 -0
- data/docs/ChatConversationNotificationDetail.md +16 -0
- data/docs/ChatConversationNotificationErrorBody.md +22 -0
- data/docs/ChatConversationNotificationErrorInfo.md +22 -0
- data/docs/ChatConversationNotificationParticipants.md +38 -0
- data/docs/ChatConversationNotificationUriReference.md +14 -0
- data/docs/ChatConversationNotificationWrapup.md +18 -0
- data/docs/ChatMediaParticipant.md +38 -0
- data/docs/ChatMediaPolicy.md +14 -0
- data/docs/ChatMediaPolicyConditions.md +18 -0
- data/docs/ChatMessage.md +21 -0
- data/docs/ChatMessageUser.md +17 -0
- data/docs/CobrowseConversation.md +17 -0
- data/docs/CobrowseConversationEntityListing.md +22 -0
- data/docs/CobrowseConversationNotification.md +16 -0
- data/docs/CobrowseConversationNotificationCobrowseMediaParticipant.md +42 -0
- data/docs/CobrowseConversationNotificationDetail.md +16 -0
- data/docs/CobrowseConversationNotificationErrorBody.md +22 -0
- data/docs/CobrowseConversationNotificationErrorInfo.md +22 -0
- data/docs/CobrowseConversationNotificationParticipants.md +42 -0
- data/docs/CobrowseConversationNotificationUriReference.md +14 -0
- data/docs/CobrowseConversationNotificationWrapup.md +18 -0
- data/docs/CobrowseMediaParticipant.md +42 -0
- data/docs/Cobrowsesession.md +25 -0
- data/docs/CommandStatus.md +20 -0
- data/docs/CommandStatusEntityListing.md +22 -0
- data/docs/Condition.md +19 -0
- data/docs/ConnectRate.md +15 -0
- data/docs/ConsultTransfer.md +14 -0
- data/docs/ConsultTransferResponse.md +13 -0
- data/docs/ConsultTransferUpdate.md +13 -0
- data/docs/ConsumedResourcesEntityListing.md +22 -0
- data/docs/ConsumingResourcesEntityListing.md +22 -0
- data/docs/Contact.md +16 -0
- data/docs/ContactAddress.md +18 -0
- data/docs/ContactCallbackRequest.md +17 -0
- data/docs/ContactList.md +25 -0
- data/docs/ContactListEntityListing.md +22 -0
- data/docs/ContactListNotification.md +25 -0
- data/docs/ContactListNotificationContactPhoneNumberColumn.md +16 -0
- data/docs/ContactListNotificationImportStatus.md +18 -0
- data/docs/ContactListNotificationPhoneColumns.md +16 -0
- data/docs/ContactListNotificationUriReference.md +14 -0
- data/docs/ContactListing.md +22 -0
- data/docs/ContactPhoneNumberColumn.md +15 -0
- data/docs/ContactSort.md +15 -0
- data/docs/ContentAttributeFilterItem.md +15 -0
- data/docs/ContentFacetFilterItem.md +16 -0
- data/docs/ContentFilterItem.md +16 -0
- data/docs/ContentManagementApi.md +2470 -0
- data/docs/ContentQueryRequest.md +20 -0
- data/docs/ContentSortItem.md +14 -0
- data/docs/Conversation.md +23 -0
- data/docs/ConversationAssociation.md +15 -0
- data/docs/ConversationBasic.md +18 -0
- data/docs/ConversationChat.md +24 -0
- data/docs/ConversationEntityListing.md +22 -0
- data/docs/ConversationNotification.md +17 -0
- data/docs/ConversationNotificationAddress.md +18 -0
- data/docs/ConversationNotificationCall.md +32 -0
- data/docs/ConversationNotificationCallback.md +30 -0
- data/docs/ConversationNotificationCallbacks.md +30 -0
- data/docs/ConversationNotificationCalls.md +32 -0
- data/docs/ConversationNotificationChat.md +22 -0
- data/docs/ConversationNotificationChats.md +22 -0
- data/docs/ConversationNotificationCobrowse.md +26 -0
- data/docs/ConversationNotificationCobrowsesessions.md +26 -0
- data/docs/ConversationNotificationDialerPreview.md +18 -0
- data/docs/ConversationNotificationDisconnectReason.md +15 -0
- data/docs/ConversationNotificationDisconnectReasons.md +15 -0
- data/docs/ConversationNotificationEmail.md +24 -0
- data/docs/ConversationNotificationEmails.md +24 -0
- data/docs/ConversationNotificationErrorDetails.md +20 -0
- data/docs/ConversationNotificationErrorInfo.md +20 -0
- data/docs/ConversationNotificationFaxStatus.md +20 -0
- data/docs/ConversationNotificationParticipant.md +40 -0
- data/docs/ConversationNotificationParticipants.md +40 -0
- data/docs/ConversationNotificationPhoneNumberColumn.md +15 -0
- data/docs/ConversationNotificationScreenshare.md +22 -0
- data/docs/ConversationNotificationScreenshares.md +22 -0
- data/docs/ConversationNotificationSelf.md +18 -0
- data/docs/ConversationNotificationSocialExpression.md +26 -0
- data/docs/ConversationNotificationSocialExpressions.md +26 -0
- data/docs/ConversationNotificationVideo.md +24 -0
- data/docs/ConversationNotificationVideos.md +24 -0
- data/docs/ConversationNotificationWrapup.md +18 -0
- data/docs/ConversationQuery.md +20 -0
- data/docs/ConversationsApi.md +4864 -0
- data/docs/CopyVoicemailMessage.md +15 -0
- data/docs/CoverSheet.md +14 -0
- data/docs/CreateCallRequest.md +21 -0
- data/docs/CreateCallResponse.md +15 -0
- data/docs/CreateCallbackCommand.md +20 -0
- data/docs/CreateCallbackResponse.md +14 -0
- data/docs/CreateEmailRequest.md +24 -0
- data/docs/CreateQueueRequest.md +35 -0
- data/docs/CreateShareRequest.md +17 -0
- data/docs/CreateShareRequestMember.md +14 -0
- data/docs/CreateShareResponse.md +23 -0
- data/docs/CreateUser.md +18 -0
- data/docs/CreateWebChatRequest.md +19 -0
- data/docs/CurrentUserScheduleRequestBody.md +14 -0
- data/docs/CustomerInteractionCenter.md +19 -0
- data/docs/DID.md +28 -0
- data/docs/DIDEntityListing.md +22 -0
- data/docs/DIDPool.md +28 -0
- data/docs/DIDPoolEntityListing.md +22 -0
- data/docs/DefaultGreetingList.md +22 -0
- data/docs/DeleteRetention.md +13 -0
- data/docs/Dependency.md +19 -0
- data/docs/DependencyObject.md +21 -0
- data/docs/DependencyObjectEntityListing.md +22 -0
- data/docs/DependencyStatus.md +21 -0
- data/docs/DependencyType.md +16 -0
- data/docs/DependencyTypeEntityListing.md +22 -0
- data/docs/Destination.md +16 -0
- data/docs/Detail.md +16 -0
- data/docs/DialerAction.md +16 -0
- data/docs/DialerAuditRequest.md +16 -0
- data/docs/DialerContact.md +20 -0
- data/docs/DialerPreview.md +17 -0
- data/docs/DialerRule.md +18 -0
- data/docs/DigitLength.md +14 -0
- data/docs/DisconnectReason.md +15 -0
- data/docs/DncList.md +24 -0
- data/docs/DncListCreate.md +24 -0
- data/docs/DncListEntityListing.md +22 -0
- data/docs/DncListNotification.md +24 -0
- data/docs/DncListNotificationImportStatus.md +18 -0
- data/docs/Document.md +43 -0
- data/docs/DocumentAttribute.md +14 -0
- data/docs/DocumentAudit.md +28 -0
- data/docs/DocumentAuditEntityListing.md +22 -0
- data/docs/DocumentDataV2Notification.md +26 -0
- data/docs/DocumentDataV2NotificationCreatedBy.md +14 -0
- data/docs/DocumentDataV2NotificationLockData.md +15 -0
- data/docs/DocumentDataV2NotificationLockInfo.md +15 -0
- data/docs/DocumentDataV2NotificationUserData.md +14 -0
- data/docs/DocumentDataV2NotificationWorkspace.md +13 -0
- data/docs/DocumentDataV2NotificationWorkspaceData.md +13 -0
- data/docs/DocumentEntityListing.md +22 -0
- data/docs/DocumentThumbnail.md +16 -0
- data/docs/DocumentUpdate.md +21 -0
- data/docs/DocumentUpload.md +16 -0
- data/docs/DocumentationResult.md +32 -0
- data/docs/DocumentationSearchCriteria.md +20 -0
- data/docs/DocumentationSearchRequest.md +17 -0
- data/docs/DocumentationSearchResponse.md +21 -0
- data/docs/DomainCapabilities.md +18 -0
- data/docs/DomainCertificateAuthority.md +28 -0
- data/docs/DomainEdgeSoftwareUpdateDto.md +22 -0
- data/docs/DomainEdgeSoftwareVersionDto.md +20 -0
- data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +22 -0
- data/docs/DomainEntity.md +15 -0
- data/docs/DomainEntityListing.md +22 -0
- data/docs/DomainEntityListingEvaluationForm.md +22 -0
- data/docs/DomainEntityListingQueryResult.md +22 -0
- data/docs/DomainLogicalInterface.md +45 -0
- data/docs/DomainNetworkAddress.md +16 -0
- data/docs/DomainNetworkCommandResponse.md +16 -0
- data/docs/DomainNetworkRoute.md +17 -0
- data/docs/DomainOrgRoleDifference.md +17 -0
- data/docs/DomainOrganizationProduct.md +13 -0
- data/docs/DomainOrganizationRole.md +23 -0
- data/docs/DomainOrganizationRoleCreate.md +23 -0
- data/docs/DomainOrganizationRoleUpdate.md +23 -0
- data/docs/DomainPermission.md +17 -0
- data/docs/DomainPermissionCollection.md +17 -0
- data/docs/DomainPermissionPolicy.md +20 -0
- data/docs/DomainPhysicalCapabilities.md +14 -0
- data/docs/DomainPhysicalInterface.md +29 -0
- data/docs/DomainResourceConditionNode.md +17 -0
- data/docs/DomainResourceConditionValue.md +16 -0
- data/docs/DomainRole.md +14 -0
- data/docs/DomainSchemaReference.md +24 -0
- data/docs/DownloadResponse.md +15 -0
- data/docs/DurationCondition.md +15 -0
- data/docs/Edge.md +50 -0
- data/docs/EdgeAutoUpdateConfig.md +16 -0
- data/docs/EdgeEntityListing.md +22 -0
- data/docs/EdgeGroup.md +27 -0
- data/docs/EdgeGroupEntityListing.md +22 -0
- data/docs/EdgeInterface.md +20 -0
- data/docs/EdgeLine.md +32 -0
- data/docs/EdgeLineEntityListing.md +22 -0
- data/docs/EdgeLogsJob.md +25 -0
- data/docs/EdgeLogsJobFile.md +30 -0
- data/docs/EdgeLogsJobRequest.md +15 -0
- data/docs/EdgeLogsJobResponse.md +24 -0
- data/docs/EdgeLogsJobUploadRequest.md +13 -0
- data/docs/EdgeRebootParameters.md +13 -0
- data/docs/EdgeServiceStateRequest.md +14 -0
- data/docs/EdgeTrunkBase.md +27 -0
- data/docs/EdgeVersionInformation.md +13 -0
- data/docs/EdgeVersionReport.md +14 -0
- data/docs/Email.md +26 -0
- data/docs/EmailAddress.md +14 -0
- data/docs/EmailAttachment.md +17 -0
- data/docs/EmailConversation.md +17 -0
- data/docs/EmailConversationEntityListing.md +22 -0
- data/docs/EmailConversationNotification.md +16 -0
- data/docs/EmailConversationNotificationDetail.md +16 -0
- data/docs/EmailConversationNotificationEmailMediaParticipant.md +39 -0
- data/docs/EmailConversationNotificationErrorBody.md +22 -0
- data/docs/EmailConversationNotificationErrorInfo.md +22 -0
- data/docs/EmailConversationNotificationParticipants.md +39 -0
- data/docs/EmailConversationNotificationUriReference.md +14 -0
- data/docs/EmailConversationNotificationWrapup.md +18 -0
- data/docs/EmailMediaParticipant.md +39 -0
- data/docs/EmailMediaPolicy.md +14 -0
- data/docs/EmailMediaPolicyConditions.md +17 -0
- data/docs/EmailMessage.md +24 -0
- data/docs/EmailMessageListing.md +22 -0
- data/docs/EmailSetup.md +13 -0
- data/docs/Empty.md +12 -0
- data/docs/EncryptionKey.md +18 -0
- data/docs/EncryptionKeyEntityListing.md +22 -0
- data/docs/Endpoint.md +30 -0
- data/docs/EndpointEntityListing.md +22 -0
- data/docs/Entry.md +14 -0
- data/docs/ErrorBody.md +22 -0
- data/docs/ErrorDetails.md +20 -0
- data/docs/EstimatedWaitTimePredictions.md +13 -0
- data/docs/Evaluation.md +32 -0
- data/docs/EvaluationAssignment.md +14 -0
- data/docs/EvaluationEntityListing.md +22 -0
- data/docs/EvaluationForm.md +21 -0
- data/docs/EvaluationFormAndScoringSet.md +14 -0
- data/docs/EvaluationFormEntityListing.md +22 -0
- data/docs/EvaluationScoringSet.md +18 -0
- data/docs/EvaluatorActivity.md +22 -0
- data/docs/EvaluatorActivityEntityListing.md +22 -0
- data/docs/ExpansionCriterium.md +14 -0
- data/docs/ExportUri.md +14 -0
- data/docs/ExportUriNotification.md +15 -0
- data/docs/Extension.md +28 -0
- data/docs/ExtensionEntityListing.md +22 -0
- data/docs/ExtensionPool.md +26 -0
- data/docs/ExtensionPoolEntityListing.md +22 -0
- data/docs/ExternalContact.md +32 -0
- data/docs/ExternalContactsApi.md +1886 -0
- data/docs/ExternalDataSource.md +14 -0
- data/docs/ExternalOrganization.md +30 -0
- data/docs/ExternalOrganizationListing.md +22 -0
- data/docs/FacetEntry.md +20 -0
- data/docs/FacetInfo.md +14 -0
- data/docs/FacetKeyAttribute.md +15 -0
- data/docs/FacetStatistics.md +19 -0
- data/docs/FacetTerm.md +18 -0
- data/docs/FailedObject.md +16 -0
- data/docs/FaxApi.md +371 -0
- data/docs/FaxDataV2Notification.md +29 -0
- data/docs/FaxDataV2NotificationLockData.md +15 -0
- data/docs/FaxDataV2NotificationLockInfo.md +15 -0
- data/docs/FaxDataV2NotificationUserData.md +14 -0
- data/docs/FaxDataV2NotificationWorkspaceData.md +13 -0
- data/docs/FaxDocument.md +30 -0
- data/docs/FaxDocumentEntityListing.md +22 -0
- data/docs/FaxSendRequest.md +21 -0
- data/docs/FaxSendResponse.md +17 -0
- data/docs/FaxStatus.md +20 -0
- data/docs/FaxSummary.md +15 -0
- data/docs/FeatureState.md +13 -0
- data/docs/FieldConfig.md +20 -0
- data/docs/FieldConfigs.md +16 -0
- data/docs/FieldList.md +21 -0
- data/docs/Flow.md +28 -0
- data/docs/FlowEntityListing.md +22 -0
- data/docs/FlowVersion.md +24 -0
- data/docs/FlowVersionEntityListing.md +22 -0
- data/docs/GSuite.md +20 -0
- data/docs/Geolocation.md +23 -0
- data/docs/GeolocationApi.md +255 -0
- data/docs/GeolocationNotification.md +17 -0
- data/docs/GeolocationSettings.md +17 -0
- data/docs/Greeting.md +24 -0
- data/docs/GreetingAudioFile.md +15 -0
- data/docs/GreetingListing.md +22 -0
- data/docs/GreetingMediaInfo.md +15 -0
- data/docs/GreetingOwner.md +15 -0
- data/docs/GreetingsApi.md +999 -0
- data/docs/Group.md +25 -0
- data/docs/GroupContact.md +16 -0
- data/docs/GroupEntityListing.md +22 -0
- data/docs/GroupMembersUpdate.md +14 -0
- data/docs/GroupSearchCriteria.md +20 -0
- data/docs/GroupSearchRequest.md +17 -0
- data/docs/GroupUpdate.md +22 -0
- data/docs/GroupsApi.md +700 -0
- data/docs/GroupsSearchResponse.md +21 -0
- data/docs/HeartBeatAlert.md +24 -0
- data/docs/HeartBeatAlertContainer.md +22 -0
- data/docs/HeartBeatAlertNotification.md +22 -0
- data/docs/HeartBeatAlertNotificationNotificationUser.md +14 -0
- data/docs/HeartBeatAlertNotificationNotificationUsers.md +14 -0
- data/docs/HeartBeatRule.md +22 -0
- data/docs/HeartBeatRuleContainer.md +22 -0
- data/docs/HeartBeatRuleNotification.md +21 -0
- data/docs/HeartBeatRuleNotificationNotificationUser.md +14 -0
- data/docs/IdentityNow.md +20 -0
- data/docs/IdentityProviderApi.md +1578 -0
- data/docs/ImportStatus.md +17 -0
- data/docs/ImportStatusNotification.md +18 -0
- data/docs/InboundDomain.md +17 -0
- data/docs/InboundDomainEntityListing.md +22 -0
- data/docs/InboundRoute.md +23 -0
- data/docs/InboundRouteEntityListing.md +22 -0
- data/docs/InitiateScreenRecording.md +15 -0
- data/docs/InteractionStatAlertNotification.md +28 -0
- data/docs/InteractionStatAlertNotificationNotificationUser.md +14 -0
- data/docs/InteractionStatRuleNotification.md +26 -0
- data/docs/InteractionStatRuleNotificationNotificationUser.md +14 -0
- data/docs/InteractionStatsAlert.md +29 -0
- data/docs/InteractionStatsAlertContainer.md +22 -0
- data/docs/InteractionStatsRule.md +26 -0
- data/docs/InteractionStatsRuleContainer.md +22 -0
- data/docs/IntradayDataUpdateNotification.md +19 -0
- data/docs/IntradayDataUpdateNotificationForecastDataPerInterval.md +15 -0
- data/docs/IntradayDataUpdateNotificationHistoricalAgentDataPerInterval.md +14 -0
- data/docs/IntradayDataUpdateNotificationHistoricalQueueDataPerInterval.md +20 -0
- data/docs/IntradayDataUpdateNotificationIntradayDataGroup.md +19 -0
- data/docs/IntradayDataUpdateNotificationIntradayDataGroupings.md +19 -0
- data/docs/IntradayDataUpdateNotificationIntradayForecastData.md +15 -0
- data/docs/IntradayDataUpdateNotificationIntradayHistoricalAgentData.md +14 -0
- data/docs/IntradayDataUpdateNotificationIntradayHistoricalQueueData.md +20 -0
- data/docs/IntradayDataUpdateNotificationIntradayMetric.md +14 -0
- data/docs/IntradayDataUpdateNotificationIntradayPerformancePredictionAgentData.md +13 -0
- data/docs/IntradayDataUpdateNotificationIntradayPerformancePredictionQueueData.md +15 -0
- data/docs/IntradayDataUpdateNotificationIntradayScheduleData.md +14 -0
- data/docs/IntradayDataUpdateNotificationMetrics.md +14 -0
- data/docs/IntradayDataUpdateNotificationPerformancePredictionAgentDataPerInterval.md +13 -0
- data/docs/IntradayDataUpdateNotificationPerformancePredictionQueueDataPerInterval.md +15 -0
- data/docs/IntradayDataUpdateNotificationScheduleDataPerInterval.md +14 -0
- data/docs/JsonNode.md +33 -0
- data/docs/JsonNodeSearchResponse.md +22 -0
- data/docs/JsonSchemaDocument.md +19 -0
- data/docs/KeyRotationSchedule.md +16 -0
- data/docs/Keyword.md +25 -0
- data/docs/KeywordSet.md +21 -0
- data/docs/KeywordSetEntityListing.md +22 -0
- data/docs/Language.md +18 -0
- data/docs/LanguageEntityListing.md +22 -0
- data/docs/LanguagesApi.md +611 -0
- data/docs/Library.md +18 -0
- data/docs/LibraryEntityListing.md +22 -0
- data/docs/LicenseApi.md +362 -0
- data/docs/LicenseAssignmentRequest.md +15 -0
- data/docs/LicenseBatchAssignmentRequest.md +13 -0
- data/docs/LicenseDefinition.md +17 -0
- data/docs/LicenseDefinitionListing.md +22 -0
- data/docs/LicenseOrganization.md +16 -0
- data/docs/LicenseUpdateResponse.md +13 -0
- data/docs/LicenseUpdateStatus.md +15 -0
- data/docs/LicenseUser.md +15 -0
- data/docs/Line.md +33 -0
- data/docs/LineBase.md +26 -0
- data/docs/LineBaseEntityListing.md +22 -0
- data/docs/LineEntityListing.md +22 -0
- data/docs/LineStatus.md +17 -0
- data/docs/LocalEncryptionConfiguration.md +18 -0
- data/docs/LocalEncryptionConfigurationListing.md +15 -0
- data/docs/LocalEncryptionKeyRequest.md +15 -0
- data/docs/Location.md +17 -0
- data/docs/LocationAddress.md +19 -0
- data/docs/LocationDefinition.md +21 -0
- data/docs/LocationEmergencyNumber.md +15 -0
- data/docs/LocationSearchCriteria.md +20 -0
- data/docs/LocationSearchRequest.md +17 -0
- data/docs/LocationsApi.md +261 -0
- data/docs/LocationsSearchResponse.md +21 -0
- data/docs/LockInfo.md +16 -0
- data/docs/LogicalInterfaceEntityListing.md +22 -0
- data/docs/ManagementUnit.md +18 -0
- data/docs/MaxParticipants.md +13 -0
- data/docs/MediaParticipantRequest.md +19 -0
- data/docs/MediaPolicies.md +15 -0
- data/docs/MediaResult.md +14 -0
- data/docs/MediaSetting.md +14 -0
- data/docs/MediaSummary.md +14 -0
- data/docs/MediaSummaryDetail.md +14 -0
- data/docs/MemberEntity.md +13 -0
- data/docs/MetaData.md +15 -0
- data/docs/Metabase.md +24 -0
- data/docs/MeteredEvaluationAssignment.md +18 -0
- data/docs/Note.md +20 -0
- data/docs/NoteListing.md +22 -0
- data/docs/NotificationsApi.md +426 -0
- data/docs/Number.md +14 -0
- data/docs/NumberPlan.md +31 -0
- data/docs/NumericRange.md +16 -0
- data/docs/OAuthApi.md +368 -0
- data/docs/OAuthClient.md +21 -0
- data/docs/OAuthClientEntityListing.md +22 -0
- data/docs/OAuthClientListing.md +20 -0
- data/docs/OAuthProvider.md +16 -0
- data/docs/OAuthProviderEntityListing.md +22 -0
- data/docs/ObservationDataContainer.md +14 -0
- data/docs/ObservationQuery.md +14 -0
- data/docs/ObservationQueryResponse.md +13 -0
- data/docs/Okta.md +19 -0
- data/docs/OneLogin.md +19 -0
- data/docs/Operation.md +21 -0
- data/docs/OrgMediaUtilization.md +15 -0
- data/docs/Organization.md +25 -0
- data/docs/OrganizationApi.md +250 -0
- data/docs/OrganizationFeatures.md +25 -0
- data/docs/OrganizationPresence.md +23 -0
- data/docs/OrganizationPresenceEntityListing.md +22 -0
- data/docs/OrganizationProductEntityListing.md +17 -0
- data/docs/OrganizationRoleEntityListing.md +22 -0
- data/docs/OrphanRecording.md +24 -0
- data/docs/OrphanRecordingListing.md +22 -0
- data/docs/OrphanUpdateRequest.md +15 -0
- data/docs/OutOfOffice.md +19 -0
- data/docs/OutOfOfficeNotification.md +17 -0
- data/docs/OutOfOfficeNotificationUser.md +13 -0
- data/docs/OutboundApi.md +4766 -0
- data/docs/OutboundRoute.md +30 -0
- data/docs/OutboundRouteBase.md +28 -0
- data/docs/OutboundRouteBaseEntityListing.md +22 -0
- data/docs/OutboundRouteEntityListing.md +22 -0
- data/docs/PINConfiguration.md +14 -0
- data/docs/Page.md +20 -0
- data/docs/PagingSpec.md +14 -0
- data/docs/Parameter.md +16 -0
- data/docs/ParsedCertificate.md +13 -0
- data/docs/Participant.md +48 -0
- data/docs/ParticipantAttributes.md +13 -0
- data/docs/ParticipantBasic.md +48 -0
- data/docs/PermissionCollectionEntityListing.md +22 -0
- data/docs/Permissions.md +15 -0
- data/docs/Phone.md +37 -0
- data/docs/PhoneBase.md +28 -0
- data/docs/PhoneBaseEntityListing.md +22 -0
- data/docs/PhoneCapabilities.md +18 -0
- data/docs/PhoneColumn.md +14 -0
- data/docs/PhoneEntityListing.md +22 -0
- data/docs/PhoneMetaBaseEntityListing.md +22 -0
- data/docs/PhoneNumber.md +18 -0
- data/docs/PhoneNumberColumn.md +14 -0
- data/docs/PhoneNumberStatus.md +13 -0
- data/docs/PhoneStatus.md +22 -0
- data/docs/PhonesReboot.md +14 -0
- data/docs/PhysicalInterfaceEntityListing.md +22 -0
- data/docs/PingIdentity.md +20 -0
- data/docs/Policy.md +24 -0
- data/docs/PolicyActions.md +20 -0
- data/docs/PolicyConditions.md +20 -0
- data/docs/PolicyCreate.md +24 -0
- data/docs/PolicyEntityListing.md +22 -0
- data/docs/PolicyErrorMessage.md +19 -0
- data/docs/PolicyErrors.md +13 -0
- data/docs/PredictionResults.md +15 -0
- data/docs/PresenceApi.md +508 -0
- data/docs/PresenceQueryResponse.md +14 -0
- data/docs/Prompt.md +18 -0
- data/docs/PromptAsset.md +24 -0
- data/docs/PromptAssetCreate.md +24 -0
- data/docs/PromptAssetEntityListing.md +22 -0
- data/docs/PromptEntityListing.md +22 -0
- data/docs/PropertyIndexRequest.md +15 -0
- data/docs/ProvisionInfo.md +15 -0
- data/docs/PureCloud.md +16 -0
- data/docs/QualifierMappingObservationQueryResponse.md +14 -0
- data/docs/QualityApi.md +2084 -0
- data/docs/QualityAudit.md +23 -0
- data/docs/QualityAuditPage.md +22 -0
- data/docs/QueryFacetInfo.md +14 -0
- data/docs/QueryRequest.md +20 -0
- data/docs/QueryResult.md +16 -0
- data/docs/QueryResults.md +14 -0
- data/docs/Question.md +24 -0
- data/docs/QuestionGroup.md +22 -0
- data/docs/QuestionGroupScore.md +23 -0
- data/docs/QuestionScore.md +18 -0
- data/docs/Queue.md +34 -0
- data/docs/QueueEmailAddress.md +14 -0
- data/docs/QueueEntityListing.md +22 -0
- data/docs/QueueMember.md +20 -0
- data/docs/QueueMemberEntityListing.md +22 -0
- data/docs/QueueMemberNotification.md +16 -0
- data/docs/QueueUtilizationDiagnostic.md +21 -0
- data/docs/Reaction.md +15 -0
- data/docs/RecallEntry.md +14 -0
- data/docs/Recording.md +34 -0
- data/docs/RecordingApi.md +2089 -0
- data/docs/RecordingDataV2Notification.md +29 -0
- data/docs/RecordingDataV2NotificationConversationData.md +13 -0
- data/docs/RecordingDataV2NotificationLockData.md +15 -0
- data/docs/RecordingDataV2NotificationLockInfo.md +15 -0
- data/docs/RecordingDataV2NotificationUserData.md +14 -0
- data/docs/RecordingDataV2NotificationWorkspaceData.md +13 -0
- data/docs/RecordingEmailMessage.md +22 -0
- data/docs/RecordingSettings.md +13 -0
- data/docs/Relationship.md +19 -0
- data/docs/RelationshipListing.md +22 -0
- data/docs/ReplaceRequest.md +15 -0
- data/docs/ReplaceResponse.md +18 -0
- data/docs/ReportMetaData.md +21 -0
- data/docs/ReportMetaDataEntityListing.md +22 -0
- data/docs/ReportRunEntry.md +23 -0
- data/docs/ReportRunEntryEntityDomainListing.md +22 -0
- data/docs/ReportSchedule.md +29 -0
- data/docs/ReportScheduleEntityListing.md +22 -0
- data/docs/ResourceConditionNode.md +17 -0
- data/docs/ResourceConditionValue.md +14 -0
- data/docs/ResourcePermissionPolicy.md +23 -0
- data/docs/Response.md +23 -0
- data/docs/ResponseEntityList.md +22 -0
- data/docs/ResponseEntityListing.md +22 -0
- data/docs/ResponseFilter.md +15 -0
- data/docs/ResponseManagementApi.md +699 -0
- data/docs/ResponseQueryRequest.md +15 -0
- data/docs/ResponseQueryResults.md +13 -0
- data/docs/ResponseSet.md +19 -0
- data/docs/ResponseSetEntityListing.md +22 -0
- data/docs/ResponseSetNotification.md +19 -0
- data/docs/ResponseSetNotificationReaction.md +16 -0
- data/docs/ResponseSetNotificationResponses.md +16 -0
- data/docs/ResponseSubstitution.md +15 -0
- data/docs/ResponseText.md +14 -0
- data/docs/RestErrorDetail.md +14 -0
- data/docs/RetentionDuration.md +14 -0
- data/docs/ReverseWhitepagesLookupResult.md +14 -0
- data/docs/Ring.md +14 -0
- data/docs/RoutingApi.md +2763 -0
- data/docs/RoutingData.md +17 -0
- data/docs/RoutingSkill.md +18 -0
- data/docs/RoutingStatus.md +15 -0
- data/docs/RoutingStatusAlert.md +23 -0
- data/docs/RoutingStatusAlertContainer.md +22 -0
- data/docs/RoutingStatusRule.md +22 -0
- data/docs/RoutingStatusRuleContainer.md +22 -0
- data/docs/RuleSet.md +21 -0
- data/docs/RuleSetDiagnostic.md +14 -0
- data/docs/RuleSetEntityListing.md +22 -0
- data/docs/RuleSetNotification.md +21 -0
- data/docs/RuleSetNotificationAction.md +17 -0
- data/docs/RuleSetNotificationActions.md +17 -0
- data/docs/RuleSetNotificationCondition.md +20 -0
- data/docs/RuleSetNotificationConditions.md +20 -0
- data/docs/RuleSetNotificationRule.md +19 -0
- data/docs/RuleSetNotificationRules.md +19 -0
- data/docs/RuleSetNotificationUriReference.md +14 -0
- data/docs/RunNowResponse.md +15 -0
- data/docs/Salesforce.md +19 -0
- data/docs/ScheduleInterval.md +14 -0
- data/docs/SchemaCategory.md +24 -0
- data/docs/SchemaCategoryEntityListing.md +22 -0
- data/docs/SchemaReferenceEntityListing.md +22 -0
- data/docs/ScreenRecordingSession.md +19 -0
- data/docs/ScreenRecordingSessionListing.md +22 -0
- data/docs/ScreenRecordingSessionRequest.md +15 -0
- data/docs/ScreenShareConversationNotification.md +16 -0
- data/docs/ScreenShareConversationNotificationDetail.md +16 -0
- data/docs/ScreenShareConversationNotificationErrorBody.md +22 -0
- data/docs/ScreenShareConversationNotificationErrorInfo.md +22 -0
- data/docs/ScreenShareConversationNotificationParticipants.md +40 -0
- data/docs/ScreenShareConversationNotificationScreenShareMediaParticipant.md +40 -0
- data/docs/ScreenShareConversationNotificationUriReference.md +14 -0
- data/docs/ScreenShareConversationNotificationWrapup.md +18 -0
- data/docs/Screenshare.md +22 -0
- data/docs/Script.md +26 -0
- data/docs/ScriptEntityListing.md +22 -0
- data/docs/ScriptsApi.md +592 -0
- data/docs/SearchAggregation.md +18 -0
- data/docs/SearchApi.md +888 -0
- data/docs/SearchCriteria.md +20 -0
- data/docs/SearchRequest.md +21 -0
- data/docs/Section.md +16 -0
- data/docs/SecurityProfile.md +16 -0
- data/docs/SecurityProfileEntityListing.md +22 -0
- data/docs/Segment.md +17 -0
- data/docs/SequenceSchedule.md +21 -0
- data/docs/SequenceScheduleNotification.md +21 -0
- data/docs/SequenceScheduleNotificationScheduleInterval.md +15 -0
- data/docs/SequenceScheduleNotificationUriReference.md +14 -0
- data/docs/ServerDate.md +13 -0
- data/docs/ServiceContext.md +13 -0
- data/docs/ServiceLevel.md +14 -0
- data/docs/Share.md +23 -0
- data/docs/ShareEntityListing.md +22 -0
- data/docs/SharedEntity.md +13 -0
- data/docs/SharedResponse.md +17 -0
- data/docs/Site.md +33 -0
- data/docs/SiteEntityListing.md +22 -0
- data/docs/SkillEntityListing.md +22 -0
- data/docs/SkillsToRemove.md +15 -0
- data/docs/SocialConversationNotification.md +16 -0
- data/docs/SocialConversationNotificationDetail.md +16 -0
- data/docs/SocialConversationNotificationErrorBody.md +22 -0
- data/docs/SocialConversationNotificationErrorInfo.md +22 -0
- data/docs/SocialConversationNotificationParticipants.md +41 -0
- data/docs/SocialConversationNotificationSocialMediaParticipant.md +41 -0
- data/docs/SocialConversationNotificationUriReference.md +14 -0
- data/docs/SocialConversationNotificationWrapup.md +18 -0
- data/docs/SocialExpression.md +26 -0
- data/docs/SortItem.md +14 -0
- data/docs/Station.md +22 -0
- data/docs/StationEntityListing.md +22 -0
- data/docs/StationsApi.md +203 -0
- data/docs/StatisticalResponse.md +15 -0
- data/docs/StatisticalSummary.md +21 -0
- data/docs/StreetAddress.md +20 -0
- data/docs/SubscriberResponse.md +14 -0
- data/docs/SuggestApi.md +272 -0
- data/docs/SuggestSearchCriteria.md +19 -0
- data/docs/SuggestSearchRequest.md +15 -0
- data/docs/SystemPresence.md +15 -0
- data/docs/SystemPrompt.md +17 -0
- data/docs/SystemPromptAsset.md +25 -0
- data/docs/SystemPromptAssetEntityListing.md +22 -0
- data/docs/SystemPromptEntityListing.md +22 -0
- data/docs/TagQueryRequest.md +15 -0
- data/docs/TagValue.md +17 -0
- data/docs/TagValueEntityListing.md +22 -0
- data/docs/TelephonyProvidersEdgeApi.md +7507 -0
- data/docs/TermAttribute.md +15 -0
- data/docs/Ticker.md +14 -0
- data/docs/TimeAllowed.md +15 -0
- data/docs/TimeInterval.md +14 -0
- data/docs/TimeOffRequest.md +30 -0
- data/docs/TimeOffRequestList.md +16 -0
- data/docs/TimeOffRequestPatch.md +13 -0
- data/docs/TimeOffRequestUpdateNotification.md +28 -0
- data/docs/TimeOffRequestUpdateNotificationUser.md +13 -0
- data/docs/TimeSlot.md +15 -0
- data/docs/TimeZone.md +16 -0
- data/docs/TimeZoneEntityListing.md +22 -0
- data/docs/TokensApi.md +66 -0
- data/docs/TransferRequest.md +17 -0
- data/docs/Trunk.md +31 -0
- data/docs/TrunkBase.md +28 -0
- data/docs/TrunkBaseAssignment.md +14 -0
- data/docs/TrunkBaseEntityListing.md +22 -0
- data/docs/TrunkEntityListing.md +22 -0
- data/docs/TrunkMetabaseEntityListing.md +22 -0
- data/docs/TrunkRecordingEnabledCount.md +14 -0
- data/docs/TwitterId.md +17 -0
- data/docs/UnreadMetric.md +13 -0
- data/docs/UnreadStatus.md +13 -0
- data/docs/UriReference.md +15 -0
- data/docs/Usage.md +13 -0
- data/docs/UsageItem.md +15 -0
- data/docs/User.md +36 -0
- data/docs/UserAgentInfo.md +15 -0
- data/docs/UserAuthorization.md +15 -0
- data/docs/UserConversationSummary.md +19 -0
- data/docs/UserConversationSummaryNotification.md +19 -0
- data/docs/UserConversationSummaryNotificationCall.md +14 -0
- data/docs/UserConversationSummaryNotificationCallContactCenter.md +14 -0
- data/docs/UserConversationSummaryNotificationMediaSummary.md +14 -0
- data/docs/UserConversationSummaryNotificationMediaSummaryDetail.md +14 -0
- data/docs/UserDetailsQuery.md +20 -0
- data/docs/UserEntityListing.md +22 -0
- data/docs/UserImage.md +14 -0
- data/docs/UserListScheduleRequestBody.md +15 -0
- data/docs/UserMe.md +48 -0
- data/docs/UserParam.md +14 -0
- data/docs/UserPresence.md +20 -0
- data/docs/UserPresenceAlert.md +25 -0
- data/docs/UserPresenceAlertContainer.md +22 -0
- data/docs/UserPresenceNotification.md +16 -0
- data/docs/UserPresenceNotificationOrganizationPresence.md +14 -0
- data/docs/UserPresenceNotificationPresenceDefinition.md +14 -0
- data/docs/UserPresenceRule.md +23 -0
- data/docs/UserPresenceRuleContainer.md +22 -0
- data/docs/UserQueue.md +35 -0
- data/docs/UserQueueEntityListing.md +22 -0
- data/docs/UserRecording.md +25 -0
- data/docs/UserRecordingEntityListing.md +22 -0
- data/docs/UserRecordingsApi.md +385 -0
- data/docs/UserRoutingSkill.md +18 -0
- data/docs/UserRoutingSkillPost.md +16 -0
- data/docs/UserRoutingStatusNotification.md +13 -0
- data/docs/UserRoutingStatusNotificationRoutingStatus.md +14 -0
- data/docs/UserSchedule.md +14 -0
- data/docs/UserScheduleActivity.md +18 -0
- data/docs/UserScheduleAdherence.md +26 -0
- data/docs/UserScheduleAdherenceUpdateNotification.md +22 -0
- data/docs/UserScheduleAdherenceUpdateNotificationUser.md +13 -0
- data/docs/UserScheduleContainer.md +14 -0
- data/docs/UserScheduleFullDayTimeOffMarker.md +17 -0
- data/docs/UserScheduleShift.md +15 -0
- data/docs/UserSearchCriteria.md +20 -0
- data/docs/UserSearchRequest.md +18 -0
- data/docs/UserSkillEntityListing.md +22 -0
- data/docs/UserStation.md +19 -0
- data/docs/UserStations.md +16 -0
- data/docs/UserStationsNotification.md +13 -0
- data/docs/UserStationsNotificationAssociatedStation.md +15 -0
- data/docs/UserStationsNotificationUser.md +13 -0
- data/docs/UserStationsNotificationUserStation.md +15 -0
- data/docs/UsersApi.md +2641 -0
- data/docs/UsersSearchResponse.md +21 -0
- data/docs/UtilitiesApi.md +189 -0
- data/docs/Utilization.md +13 -0
- data/docs/ValidateAddressRequest.md +13 -0
- data/docs/ValidateAddressResponse.md +14 -0
- data/docs/Video.md +23 -0
- data/docs/VideoConversationNotification.md +16 -0
- data/docs/VideoConversationNotificationDetail.md +16 -0
- data/docs/VideoConversationNotificationErrorBody.md +22 -0
- data/docs/VideoConversationNotificationErrorInfo.md +22 -0
- data/docs/VideoConversationNotificationParticipants.md +42 -0
- data/docs/VideoConversationNotificationUriReference.md +14 -0
- data/docs/VideoConversationNotificationVideoMediaParticipant.md +42 -0
- data/docs/VideoConversationNotificationWrapup.md +18 -0
- data/docs/VisibilityCondition.md +14 -0
- data/docs/VmPairingInfo.md +16 -0
- data/docs/VoicemailApi.md +1336 -0
- data/docs/VoicemailCopyRecord.md +15 -0
- data/docs/VoicemailGroupPolicy.md +18 -0
- data/docs/VoicemailMailboxInfo.md +18 -0
- data/docs/VoicemailMediaInfo.md +15 -0
- data/docs/VoicemailMessage.md +29 -0
- data/docs/VoicemailMessageEntityListing.md +22 -0
- data/docs/VoicemailMessageNotification.md +24 -0
- data/docs/VoicemailOrganizationPolicy.md +19 -0
- data/docs/VoicemailSearchCriteria.md +20 -0
- data/docs/VoicemailSearchRequest.md +18 -0
- data/docs/VoicemailUserPolicy.md +16 -0
- data/docs/VoicemailsSearchResponse.md +21 -0
- data/docs/WfmUserEntityListing.md +13 -0
- data/docs/WorkforceManagementApi.md +699 -0
- data/docs/Workspace.md +24 -0
- data/docs/WorkspaceCreate.md +15 -0
- data/docs/WorkspaceEntityListing.md +22 -0
- data/docs/WorkspaceMember.md +21 -0
- data/docs/WorkspaceMemberEntityListing.md +22 -0
- data/docs/WorkspaceSummary.md +14 -0
- data/docs/WrapUpCodeMapping.md +20 -0
- data/docs/WrapUpCodeMappingNotification.md +19 -0
- data/docs/Wrapup.md +19 -0
- data/docs/WrapupCode.md +19 -0
- data/docs/WrapupCodeEntityListing.md +22 -0
- data/git_push.sh +52 -0
- data/lib/purecloudplatformclientv2.rb +949 -0
- data/lib/purecloudplatformclientv2/api/alerting_api.rb +2016 -0
- data/lib/purecloudplatformclientv2/api/analytics_api.rb +1301 -0
- data/lib/purecloudplatformclientv2/api/architect_api.rb +2860 -0
- data/lib/purecloudplatformclientv2/api/attributes_api.rb +374 -0
- data/lib/purecloudplatformclientv2/api/authorization_api.rb +1043 -0
- data/lib/purecloudplatformclientv2/api/content_management_api.rb +2416 -0
- data/lib/purecloudplatformclientv2/api/conversations_api.rb +4725 -0
- data/lib/purecloudplatformclientv2/api/external_contacts_api.rb +1810 -0
- data/lib/purecloudplatformclientv2/api/fax_api.rb +370 -0
- data/lib/purecloudplatformclientv2/api/geolocation_api.rb +263 -0
- data/lib/purecloudplatformclientv2/api/greetings_api.rb +974 -0
- data/lib/purecloudplatformclientv2/api/groups_api.rb +696 -0
- data/lib/purecloudplatformclientv2/api/identity_provider_api.rb +1547 -0
- data/lib/purecloudplatformclientv2/api/languages_api.rb +604 -0
- data/lib/purecloudplatformclientv2/api/license_api.rb +357 -0
- data/lib/purecloudplatformclientv2/api/locations_api.rb +267 -0
- data/lib/purecloudplatformclientv2/api/notifications_api.rb +424 -0
- data/lib/purecloudplatformclientv2/api/o_auth_api.rb +368 -0
- data/lib/purecloudplatformclientv2/api/organization_api.rb +262 -0
- data/lib/purecloudplatformclientv2/api/outbound_api.rb +4670 -0
- data/lib/purecloudplatformclientv2/api/presence_api.rb +505 -0
- data/lib/purecloudplatformclientv2/api/quality_api.rb +2069 -0
- data/lib/purecloudplatformclientv2/api/recording_api.rb +2042 -0
- data/lib/purecloudplatformclientv2/api/response_management_api.rb +693 -0
- data/lib/purecloudplatformclientv2/api/routing_api.rb +2690 -0
- data/lib/purecloudplatformclientv2/api/scripts_api.rb +597 -0
- data/lib/purecloudplatformclientv2/api/search_api.rb +862 -0
- data/lib/purecloudplatformclientv2/api/stations_api.rb +212 -0
- data/lib/purecloudplatformclientv2/api/suggest_api.rb +275 -0
- data/lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb +7258 -0
- data/lib/purecloudplatformclientv2/api/tokens_api.rb +80 -0
- data/lib/purecloudplatformclientv2/api/user_recordings_api.rb +385 -0
- data/lib/purecloudplatformclientv2/api/users_api.rb +2557 -0
- data/lib/purecloudplatformclientv2/api/utilities_api.rb +196 -0
- data/lib/purecloudplatformclientv2/api/voicemail_api.rb +1294 -0
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +675 -0
- data/lib/purecloudplatformclientv2/api_client.rb +336 -0
- data/lib/purecloudplatformclientv2/api_error.rb +40 -0
- data/lib/purecloudplatformclientv2/configuration.rb +170 -0
- data/lib/purecloudplatformclientv2/models/actions.rb +180 -0
- data/lib/purecloudplatformclientv2/models/activity_code.rb +264 -0
- data/lib/purecloudplatformclientv2/models/activity_code_container.rb +182 -0
- data/lib/purecloudplatformclientv2/models/acw_settings.rb +203 -0
- data/lib/purecloudplatformclientv2/models/address.rb +219 -0
- data/lib/purecloudplatformclientv2/models/addressable_entity_user.rb +189 -0
- data/lib/purecloudplatformclientv2/models/addressable_license_definition.rb +189 -0
- data/lib/purecloudplatformclientv2/models/adfs.rb +243 -0
- data/lib/purecloudplatformclientv2/models/adjacents.rb +202 -0
- data/lib/purecloudplatformclientv2/models/agent.rb +179 -0
- data/lib/purecloudplatformclientv2/models/agent_activity.rb +236 -0
- data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/agent_evaluator_activity.rb +234 -0
- data/lib/purecloudplatformclientv2/models/aggregate_data_container.rb +192 -0
- data/lib/purecloudplatformclientv2/models/aggregate_metric_data.rb +210 -0
- data/lib/purecloudplatformclientv2/models/aggregate_query_response.rb +180 -0
- data/lib/purecloudplatformclientv2/models/aggregate_view_data.rb +187 -0
- data/lib/purecloudplatformclientv2/models/aggregation_query.rb +255 -0
- data/lib/purecloudplatformclientv2/models/aggregation_range.rb +189 -0
- data/lib/purecloudplatformclientv2/models/aggregation_result.rb +232 -0
- data/lib/purecloudplatformclientv2/models/aggregation_result_entry.rb +208 -0
- data/lib/purecloudplatformclientv2/models/analytics_conversation.rb +220 -0
- data/lib/purecloudplatformclientv2/models/analytics_conversation_query_response.rb +191 -0
- data/lib/purecloudplatformclientv2/models/analytics_conversation_segment.rb +427 -0
- data/lib/purecloudplatformclientv2/models/analytics_evaluation.rb +259 -0
- data/lib/purecloudplatformclientv2/models/analytics_participant.rb +248 -0
- data/lib/purecloudplatformclientv2/models/analytics_property.rb +225 -0
- data/lib/purecloudplatformclientv2/models/analytics_query_aggregation.rb +235 -0
- data/lib/purecloudplatformclientv2/models/analytics_query_clause.rb +213 -0
- data/lib/purecloudplatformclientv2/models/analytics_query_filter.rb +221 -0
- data/lib/purecloudplatformclientv2/models/analytics_query_predicate.rb +319 -0
- data/lib/purecloudplatformclientv2/models/analytics_routing_status_record.rb +223 -0
- data/lib/purecloudplatformclientv2/models/analytics_session.rb +490 -0
- data/lib/purecloudplatformclientv2/models/analytics_user_detail.rb +203 -0
- data/lib/purecloudplatformclientv2/models/analytics_user_details_query_response.rb +191 -0
- data/lib/purecloudplatformclientv2/models/analytics_user_presence_record.rb +233 -0
- data/lib/purecloudplatformclientv2/models/analytics_view.rb +235 -0
- data/lib/purecloudplatformclientv2/models/annotation.rb +355 -0
- data/lib/purecloudplatformclientv2/models/answer_option.rb +196 -0
- data/lib/purecloudplatformclientv2/models/archive_retention.rb +201 -0
- data/lib/purecloudplatformclientv2/models/attachment.rb +214 -0
- data/lib/purecloudplatformclientv2/models/attempt_limits.rb +280 -0
- data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/attempt_limits_notification.rb +293 -0
- data/lib/purecloudplatformclientv2/models/attempt_limits_notification_recall_entries.rb +196 -0
- data/lib/purecloudplatformclientv2/models/attempt_limits_notification_recall_entry.rb +196 -0
- data/lib/purecloudplatformclientv2/models/attribute.rb +259 -0
- data/lib/purecloudplatformclientv2/models/attribute_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/attribute_filter_item.rb +212 -0
- data/lib/purecloudplatformclientv2/models/attribute_query_request.rb +200 -0
- data/lib/purecloudplatformclientv2/models/audit_change.rb +209 -0
- data/lib/purecloudplatformclientv2/models/audit_entity.rb +213 -0
- data/lib/purecloudplatformclientv2/models/audit_entity_reference.rb +228 -0
- data/lib/purecloudplatformclientv2/models/audit_facet.rb +197 -0
- data/lib/purecloudplatformclientv2/models/audit_filter.rb +227 -0
- data/lib/purecloudplatformclientv2/models/audit_message.rb +349 -0
- data/lib/purecloudplatformclientv2/models/audit_search_result.rb +231 -0
- data/lib/purecloudplatformclientv2/models/audit_user.rb +203 -0
- data/lib/purecloudplatformclientv2/models/available_language_list.rb +180 -0
- data/lib/purecloudplatformclientv2/models/available_topic.rb +210 -0
- data/lib/purecloudplatformclientv2/models/available_topic_entity_listing.rb +180 -0
- data/lib/purecloudplatformclientv2/models/available_translations.rb +191 -0
- data/lib/purecloudplatformclientv2/models/bullseye.rb +180 -0
- data/lib/purecloudplatformclientv2/models/calibration.rb +320 -0
- data/lib/purecloudplatformclientv2/models/calibration_assignment.rb +207 -0
- data/lib/purecloudplatformclientv2/models/calibration_create.rb +325 -0
- data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/call.rb +418 -0
- data/lib/purecloudplatformclientv2/models/call_basic.rb +418 -0
- data/lib/purecloudplatformclientv2/models/call_command.rb +183 -0
- data/lib/purecloudplatformclientv2/models/call_conversation.rb +245 -0
- data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/call_conversation_notification.rb +232 -0
- data/lib/purecloudplatformclientv2/models/call_conversation_notification_call_media_participant.rb +551 -0
- data/lib/purecloudplatformclientv2/models/call_conversation_notification_detail.rb +205 -0
- data/lib/purecloudplatformclientv2/models/call_conversation_notification_error_body.rb +265 -0
- data/lib/purecloudplatformclientv2/models/call_conversation_notification_error_info.rb +265 -0
- data/lib/purecloudplatformclientv2/models/call_conversation_notification_fax_status.rb +241 -0
- data/lib/purecloudplatformclientv2/models/call_conversation_notification_participants.rb +551 -0
- data/lib/purecloudplatformclientv2/models/call_conversation_notification_uri_reference.rb +187 -0
- data/lib/purecloudplatformclientv2/models/call_conversation_notification_wrapup.rb +225 -0
- data/lib/purecloudplatformclientv2/models/call_forwarding.rb +235 -0
- data/lib/purecloudplatformclientv2/models/call_media_participant.rb +587 -0
- data/lib/purecloudplatformclientv2/models/call_media_policy.rb +189 -0
- data/lib/purecloudplatformclientv2/models/call_media_policy_conditions.rb +242 -0
- data/lib/purecloudplatformclientv2/models/call_record.rb +189 -0
- data/lib/purecloudplatformclientv2/models/callable_contacts_diagnostic.rb +213 -0
- data/lib/purecloudplatformclientv2/models/callable_time.rb +195 -0
- data/lib/purecloudplatformclientv2/models/callable_time_set.rb +244 -0
- data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/callable_time_set_notification.rb +234 -0
- data/lib/purecloudplatformclientv2/models/callable_time_set_notification_callable_time.rb +198 -0
- data/lib/purecloudplatformclientv2/models/callable_time_set_notification_callable_times.rb +198 -0
- data/lib/purecloudplatformclientv2/models/callable_time_set_notification_time_slot.rb +205 -0
- data/lib/purecloudplatformclientv2/models/callable_time_set_notification_time_slots.rb +205 -0
- data/lib/purecloudplatformclientv2/models/callback.rb +395 -0
- data/lib/purecloudplatformclientv2/models/callback_basic.rb +395 -0
- data/lib/purecloudplatformclientv2/models/callback_conversation.rb +222 -0
- data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/callback_conversation_notification.rb +209 -0
- data/lib/purecloudplatformclientv2/models/callback_conversation_notification_callback_media_participant.rb +503 -0
- data/lib/purecloudplatformclientv2/models/callback_conversation_notification_detail.rb +205 -0
- data/lib/purecloudplatformclientv2/models/callback_conversation_notification_dialer_preview.rb +225 -0
- data/lib/purecloudplatformclientv2/models/callback_conversation_notification_error_body.rb +265 -0
- data/lib/purecloudplatformclientv2/models/callback_conversation_notification_error_info.rb +265 -0
- data/lib/purecloudplatformclientv2/models/callback_conversation_notification_error_info_details.rb +205 -0
- data/lib/purecloudplatformclientv2/models/callback_conversation_notification_participants.rb +503 -0
- data/lib/purecloudplatformclientv2/models/callback_conversation_notification_phone_number_column.rb +196 -0
- data/lib/purecloudplatformclientv2/models/callback_conversation_notification_uri_reference.rb +187 -0
- data/lib/purecloudplatformclientv2/models/callback_conversation_notification_wrapup.rb +225 -0
- data/lib/purecloudplatformclientv2/models/callback_identifier.rb +211 -0
- data/lib/purecloudplatformclientv2/models/callback_media_participant.rb +535 -0
- data/lib/purecloudplatformclientv2/models/campaign.rb +514 -0
- data/lib/purecloudplatformclientv2/models/campaign_diagnostics.rb +211 -0
- data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/campaign_interaction.rb +384 -0
- data/lib/purecloudplatformclientv2/models/campaign_interactions.rb +233 -0
- data/lib/purecloudplatformclientv2/models/campaign_notification.rb +488 -0
- data/lib/purecloudplatformclientv2/models/campaign_notification_contact_sort.rb +219 -0
- data/lib/purecloudplatformclientv2/models/campaign_notification_errors.rb +196 -0
- data/lib/purecloudplatformclientv2/models/campaign_notification_phone_column.rb +196 -0
- data/lib/purecloudplatformclientv2/models/campaign_notification_phone_columns.rb +196 -0
- data/lib/purecloudplatformclientv2/models/campaign_notification_rest_error_detail.rb +196 -0
- data/lib/purecloudplatformclientv2/models/campaign_notification_uri_reference.rb +187 -0
- data/lib/purecloudplatformclientv2/models/campaign_progress.rb +227 -0
- data/lib/purecloudplatformclientv2/models/campaign_progress_notification.rb +214 -0
- data/lib/purecloudplatformclientv2/models/campaign_progress_notification_uri_reference.rb +187 -0
- data/lib/purecloudplatformclientv2/models/campaign_rule.rb +292 -0
- data/lib/purecloudplatformclientv2/models/campaign_rule_action.rb +219 -0
- data/lib/purecloudplatformclientv2/models/campaign_rule_action_entities.rb +200 -0
- data/lib/purecloudplatformclientv2/models/campaign_rule_condition.rb +210 -0
- data/lib/purecloudplatformclientv2/models/campaign_rule_entities.rb +191 -0
- data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/campaign_rule_notification.rb +272 -0
- data/lib/purecloudplatformclientv2/models/campaign_rule_notification_campaign_rule_action.rb +230 -0
- data/lib/purecloudplatformclientv2/models/campaign_rule_notification_campaign_rule_action_entities.rb +209 -0
- data/lib/purecloudplatformclientv2/models/campaign_rule_notification_campaign_rule_actions.rb +230 -0
- data/lib/purecloudplatformclientv2/models/campaign_rule_notification_campaign_rule_condition.rb +221 -0
- data/lib/purecloudplatformclientv2/models/campaign_rule_notification_campaign_rule_conditions.rb +221 -0
- data/lib/purecloudplatformclientv2/models/campaign_rule_notification_campaign_rule_entities.rb +191 -0
- data/lib/purecloudplatformclientv2/models/campaign_rule_notification_uri_reference.rb +187 -0
- data/lib/purecloudplatformclientv2/models/campaign_rule_parameters.rb +251 -0
- data/lib/purecloudplatformclientv2/models/campaign_schedule.rb +272 -0
- data/lib/purecloudplatformclientv2/models/campaign_schedule_notification.rb +252 -0
- data/lib/purecloudplatformclientv2/models/campaign_schedule_notification_intervals.rb +196 -0
- data/lib/purecloudplatformclientv2/models/campaign_schedule_notification_schedule_interval.rb +196 -0
- data/lib/purecloudplatformclientv2/models/campaign_schedule_notification_uri_reference.rb +187 -0
- data/lib/purecloudplatformclientv2/models/campaign_sequence.rb +306 -0
- data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/campaign_sequence_notification.rb +284 -0
- data/lib/purecloudplatformclientv2/models/campaign_sequence_notification_uri_reference.rb +187 -0
- data/lib/purecloudplatformclientv2/models/campaign_stats.rb +229 -0
- data/lib/purecloudplatformclientv2/models/campaign_time_slot.rb +203 -0
- data/lib/purecloudplatformclientv2/models/certificate.rb +184 -0
- data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/certificate_details.rb +238 -0
- data/lib/purecloudplatformclientv2/models/change.rb +212 -0
- data/lib/purecloudplatformclientv2/models/channel.rb +188 -0
- data/lib/purecloudplatformclientv2/models/channel_entity_listing.rb +180 -0
- data/lib/purecloudplatformclientv2/models/channel_topic.rb +189 -0
- data/lib/purecloudplatformclientv2/models/channel_topic_entity_listing.rb +180 -0
- data/lib/purecloudplatformclientv2/models/chat.rb +178 -0
- data/lib/purecloudplatformclientv2/models/chat_conversation.rb +222 -0
- data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/chat_conversation_notification.rb +209 -0
- data/lib/purecloudplatformclientv2/models/chat_conversation_notification_chat_media_participant.rb +447 -0
- data/lib/purecloudplatformclientv2/models/chat_conversation_notification_detail.rb +205 -0
- data/lib/purecloudplatformclientv2/models/chat_conversation_notification_error_body.rb +265 -0
- data/lib/purecloudplatformclientv2/models/chat_conversation_notification_error_info.rb +265 -0
- data/lib/purecloudplatformclientv2/models/chat_conversation_notification_participants.rb +447 -0
- data/lib/purecloudplatformclientv2/models/chat_conversation_notification_uri_reference.rb +187 -0
- data/lib/purecloudplatformclientv2/models/chat_conversation_notification_wrapup.rb +225 -0
- data/lib/purecloudplatformclientv2/models/chat_media_participant.rb +473 -0
- data/lib/purecloudplatformclientv2/models/chat_media_policy.rb +189 -0
- data/lib/purecloudplatformclientv2/models/chat_media_policy_conditions.rb +231 -0
- data/lib/purecloudplatformclientv2/models/chat_message.rb +250 -0
- data/lib/purecloudplatformclientv2/models/chat_message_user.rb +216 -0
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation.rb +222 -0
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_notification.rb +209 -0
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_notification_cobrowse_media_participant.rb +485 -0
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_notification_detail.rb +205 -0
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_notification_error_body.rb +265 -0
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_notification_error_info.rb +265 -0
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_notification_participants.rb +485 -0
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_notification_uri_reference.rb +187 -0
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_notification_wrapup.rb +225 -0
- data/lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb +515 -0
- data/lib/purecloudplatformclientv2/models/cobrowsesession.rb +331 -0
- data/lib/purecloudplatformclientv2/models/command_status.rb +272 -0
- data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/condition.rb +283 -0
- data/lib/purecloudplatformclientv2/models/connect_rate.rb +199 -0
- data/lib/purecloudplatformclientv2/models/consult_transfer.rb +207 -0
- data/lib/purecloudplatformclientv2/models/consult_transfer_response.rb +183 -0
- data/lib/purecloudplatformclientv2/models/consult_transfer_update.rb +197 -0
- data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/contact.rb +235 -0
- data/lib/purecloudplatformclientv2/models/contact_address.rb +223 -0
- data/lib/purecloudplatformclientv2/models/contact_callback_request.rb +239 -0
- data/lib/purecloudplatformclientv2/models/contact_list.rb +312 -0
- data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/contact_list_notification.rb +292 -0
- data/lib/purecloudplatformclientv2/models/contact_list_notification_contact_phone_number_column.rb +205 -0
- data/lib/purecloudplatformclientv2/models/contact_list_notification_import_status.rb +237 -0
- data/lib/purecloudplatformclientv2/models/contact_list_notification_phone_columns.rb +205 -0
- data/lib/purecloudplatformclientv2/models/contact_list_notification_uri_reference.rb +187 -0
- data/lib/purecloudplatformclientv2/models/contact_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/contact_phone_number_column.rb +207 -0
- data/lib/purecloudplatformclientv2/models/contact_sort.rb +212 -0
- data/lib/purecloudplatformclientv2/models/content_attribute_filter_item.rb +212 -0
- data/lib/purecloudplatformclientv2/models/content_facet_filter_item.rb +235 -0
- data/lib/purecloudplatformclientv2/models/content_filter_item.rb +235 -0
- data/lib/purecloudplatformclientv2/models/content_query_request.rb +249 -0
- data/lib/purecloudplatformclientv2/models/content_sort_item.rb +187 -0
- data/lib/purecloudplatformclientv2/models/conversation.rb +318 -0
- data/lib/purecloudplatformclientv2/models/conversation_association.rb +225 -0
- data/lib/purecloudplatformclientv2/models/conversation_basic.rb +233 -0
- data/lib/purecloudplatformclientv2/models/conversation_chat.rb +333 -0
- data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/conversation_notification.rb +216 -0
- data/lib/purecloudplatformclientv2/models/conversation_notification_address.rb +223 -0
- data/lib/purecloudplatformclientv2/models/conversation_notification_call.rb +407 -0
- data/lib/purecloudplatformclientv2/models/conversation_notification_callback.rb +375 -0
- data/lib/purecloudplatformclientv2/models/conversation_notification_callbacks.rb +375 -0
- data/lib/purecloudplatformclientv2/models/conversation_notification_calls.rb +407 -0
- data/lib/purecloudplatformclientv2/models/conversation_notification_chat.rb +287 -0
- data/lib/purecloudplatformclientv2/models/conversation_notification_chats.rb +287 -0
- data/lib/purecloudplatformclientv2/models/conversation_notification_cobrowse.rb +325 -0
- data/lib/purecloudplatformclientv2/models/conversation_notification_cobrowsesessions.rb +325 -0
- data/lib/purecloudplatformclientv2/models/conversation_notification_dialer_preview.rb +225 -0
- data/lib/purecloudplatformclientv2/models/conversation_notification_disconnect_reason.rb +210 -0
- data/lib/purecloudplatformclientv2/models/conversation_notification_disconnect_reasons.rb +210 -0
- data/lib/purecloudplatformclientv2/models/conversation_notification_email.rb +305 -0
- data/lib/purecloudplatformclientv2/models/conversation_notification_emails.rb +305 -0
- data/lib/purecloudplatformclientv2/models/conversation_notification_error_details.rb +243 -0
- data/lib/purecloudplatformclientv2/models/conversation_notification_error_info.rb +243 -0
- data/lib/purecloudplatformclientv2/models/conversation_notification_fax_status.rb +241 -0
- data/lib/purecloudplatformclientv2/models/conversation_notification_participant.rb +439 -0
- data/lib/purecloudplatformclientv2/models/conversation_notification_participants.rb +439 -0
- data/lib/purecloudplatformclientv2/models/conversation_notification_phone_number_column.rb +196 -0
- data/lib/purecloudplatformclientv2/models/conversation_notification_screenshare.rb +287 -0
- data/lib/purecloudplatformclientv2/models/conversation_notification_screenshares.rb +287 -0
- data/lib/purecloudplatformclientv2/models/conversation_notification_self.rb +223 -0
- data/lib/purecloudplatformclientv2/models/conversation_notification_social_expression.rb +323 -0
- data/lib/purecloudplatformclientv2/models/conversation_notification_social_expressions.rb +323 -0
- data/lib/purecloudplatformclientv2/models/conversation_notification_video.rb +305 -0
- data/lib/purecloudplatformclientv2/models/conversation_notification_videos.rb +305 -0
- data/lib/purecloudplatformclientv2/models/conversation_notification_wrapup.rb +225 -0
- data/lib/purecloudplatformclientv2/models/conversation_query.rb +285 -0
- data/lib/purecloudplatformclientv2/models/copy_voicemail_message.rb +204 -0
- data/lib/purecloudplatformclientv2/models/cover_sheet.rb +189 -0
- data/lib/purecloudplatformclientv2/models/create_call_request.rb +265 -0
- data/lib/purecloudplatformclientv2/models/create_call_response.rb +198 -0
- data/lib/purecloudplatformclientv2/models/create_callback_command.rb +257 -0
- data/lib/purecloudplatformclientv2/models/create_callback_response.rb +199 -0
- data/lib/purecloudplatformclientv2/models/create_email_request.rb +315 -0
- data/lib/purecloudplatformclientv2/models/create_queue_request.rb +433 -0
- data/lib/purecloudplatformclientv2/models/create_share_request.rb +255 -0
- data/lib/purecloudplatformclientv2/models/create_share_request_member.rb +201 -0
- data/lib/purecloudplatformclientv2/models/create_share_response.rb +302 -0
- data/lib/purecloudplatformclientv2/models/create_user.rb +241 -0
- data/lib/purecloudplatformclientv2/models/create_web_chat_request.rb +251 -0
- data/lib/purecloudplatformclientv2/models/current_user_schedule_request_body.rb +198 -0
- data/lib/purecloudplatformclientv2/models/customer_interaction_center.rb +234 -0
- data/lib/purecloudplatformclientv2/models/default_greeting_list.rb +279 -0
- data/lib/purecloudplatformclientv2/models/delete_retention.rb +178 -0
- data/lib/purecloudplatformclientv2/models/dependency.rb +248 -0
- data/lib/purecloudplatformclientv2/models/dependency_object.rb +270 -0
- data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/dependency_status.rb +270 -0
- data/lib/purecloudplatformclientv2/models/dependency_type.rb +207 -0
- data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/destination.rb +210 -0
- data/lib/purecloudplatformclientv2/models/detail.rb +205 -0
- data/lib/purecloudplatformclientv2/models/dialer_action.rb +261 -0
- data/lib/purecloudplatformclientv2/models/dialer_audit_request.rb +215 -0
- data/lib/purecloudplatformclientv2/models/dialer_contact.rb +258 -0
- data/lib/purecloudplatformclientv2/models/dialer_preview.rb +220 -0
- data/lib/purecloudplatformclientv2/models/dialer_rule.rb +259 -0
- data/lib/purecloudplatformclientv2/models/did.rb +351 -0
- data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/did_pool.rb +361 -0
- data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/digit_length.rb +187 -0
- data/lib/purecloudplatformclientv2/models/disconnect_reason.rb +213 -0
- data/lib/purecloudplatformclientv2/models/dnc_list.rb +309 -0
- data/lib/purecloudplatformclientv2/models/dnc_list_create.rb +309 -0
- data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/dnc_list_notification.rb +293 -0
- data/lib/purecloudplatformclientv2/models/dnc_list_notification_import_status.rb +237 -0
- data/lib/purecloudplatformclientv2/models/document.rb +506 -0
- data/lib/purecloudplatformclientv2/models/document_attribute.rb +189 -0
- data/lib/purecloudplatformclientv2/models/document_audit.rb +374 -0
- data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/document_data_v2_notification.rb +295 -0
- data/lib/purecloudplatformclientv2/models/document_data_v2_notification_created_by.rb +187 -0
- data/lib/purecloudplatformclientv2/models/document_data_v2_notification_lock_data.rb +196 -0
- data/lib/purecloudplatformclientv2/models/document_data_v2_notification_lock_info.rb +196 -0
- data/lib/purecloudplatformclientv2/models/document_data_v2_notification_user_data.rb +187 -0
- data/lib/purecloudplatformclientv2/models/document_data_v2_notification_workspace.rb +178 -0
- data/lib/purecloudplatformclientv2/models/document_data_v2_notification_workspace_data.rb +178 -0
- data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/document_thumbnail.rb +205 -0
- data/lib/purecloudplatformclientv2/models/document_update.rb +267 -0
- data/lib/purecloudplatformclientv2/models/document_upload.rb +219 -0
- data/lib/purecloudplatformclientv2/models/documentation_result.rb +393 -0
- data/lib/purecloudplatformclientv2/models/documentation_search_criteria.rb +287 -0
- data/lib/purecloudplatformclientv2/models/documentation_search_request.rb +234 -0
- data/lib/purecloudplatformclientv2/models/documentation_search_response.rb +287 -0
- data/lib/purecloudplatformclientv2/models/domain_capabilities.rb +229 -0
- data/lib/purecloudplatformclientv2/models/domain_certificate_authority.rb +371 -0
- data/lib/purecloudplatformclientv2/models/domain_edge_software_update_dto.rb +281 -0
- data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto.rb +244 -0
- data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/domain_entity.rb +198 -0
- data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +261 -0
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +261 -0
- data/lib/purecloudplatformclientv2/models/domain_logical_interface.rb +552 -0
- data/lib/purecloudplatformclientv2/models/domain_network_address.rb +237 -0
- data/lib/purecloudplatformclientv2/models/domain_network_command_response.rb +205 -0
- data/lib/purecloudplatformclientv2/models/domain_network_route.rb +233 -0
- data/lib/purecloudplatformclientv2/models/domain_org_role_difference.rb +220 -0
- data/lib/purecloudplatformclientv2/models/domain_organization_product.rb +178 -0
- data/lib/purecloudplatformclientv2/models/domain_organization_role.rb +275 -0
- data/lib/purecloudplatformclientv2/models/domain_organization_role_create.rb +280 -0
- data/lib/purecloudplatformclientv2/models/domain_organization_role_update.rb +280 -0
- data/lib/purecloudplatformclientv2/models/domain_permission.rb +214 -0
- data/lib/purecloudplatformclientv2/models/domain_permission_collection.rb +218 -0
- data/lib/purecloudplatformclientv2/models/domain_permission_policy.rb +245 -0
- data/lib/purecloudplatformclientv2/models/domain_physical_capabilities.rb +187 -0
- data/lib/purecloudplatformclientv2/models/domain_physical_interface.rb +345 -0
- data/lib/purecloudplatformclientv2/models/domain_resource_condition_node.rb +246 -0
- data/lib/purecloudplatformclientv2/models/domain_resource_condition_value.rb +219 -0
- data/lib/purecloudplatformclientv2/models/domain_role.rb +189 -0
- data/lib/purecloudplatformclientv2/models/domain_schema_reference.rb +300 -0
- data/lib/purecloudplatformclientv2/models/download_response.rb +198 -0
- data/lib/purecloudplatformclientv2/models/duration_condition.rb +210 -0
- data/lib/purecloudplatformclientv2/models/edge.rb +594 -0
- data/lib/purecloudplatformclientv2/models/edge_auto_update_config.rb +207 -0
- data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/edge_group.rb +340 -0
- data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/edge_interface.rb +245 -0
- data/lib/purecloudplatformclientv2/models/edge_line.rb +388 -0
- data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/edge_logs_job.rb +312 -0
- data/lib/purecloudplatformclientv2/models/edge_logs_job_file.rb +374 -0
- data/lib/purecloudplatformclientv2/models/edge_logs_job_request.rb +199 -0
- data/lib/purecloudplatformclientv2/models/edge_logs_job_response.rb +300 -0
- data/lib/purecloudplatformclientv2/models/edge_logs_job_upload_request.rb +185 -0
- data/lib/purecloudplatformclientv2/models/edge_reboot_parameters.rb +179 -0
- data/lib/purecloudplatformclientv2/models/edge_service_state_request.rb +193 -0
- data/lib/purecloudplatformclientv2/models/edge_trunk_base.rb +353 -0
- data/lib/purecloudplatformclientv2/models/edge_version_information.rb +178 -0
- data/lib/purecloudplatformclientv2/models/edge_version_report.rb +187 -0
- data/lib/purecloudplatformclientv2/models/email.rb +352 -0
- data/lib/purecloudplatformclientv2/models/email_address.rb +187 -0
- data/lib/purecloudplatformclientv2/models/email_attachment.rb +214 -0
- data/lib/purecloudplatformclientv2/models/email_conversation.rb +222 -0
- data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/email_conversation_notification.rb +209 -0
- data/lib/purecloudplatformclientv2/models/email_conversation_notification_detail.rb +205 -0
- data/lib/purecloudplatformclientv2/models/email_conversation_notification_email_media_participant.rb +456 -0
- data/lib/purecloudplatformclientv2/models/email_conversation_notification_error_body.rb +265 -0
- data/lib/purecloudplatformclientv2/models/email_conversation_notification_error_info.rb +265 -0
- data/lib/purecloudplatformclientv2/models/email_conversation_notification_participants.rb +456 -0
- data/lib/purecloudplatformclientv2/models/email_conversation_notification_uri_reference.rb +187 -0
- data/lib/purecloudplatformclientv2/models/email_conversation_notification_wrapup.rb +225 -0
- data/lib/purecloudplatformclientv2/models/email_media_participant.rb +483 -0
- data/lib/purecloudplatformclientv2/models/email_media_policy.rb +189 -0
- data/lib/purecloudplatformclientv2/models/email_media_policy_conditions.rb +222 -0
- data/lib/purecloudplatformclientv2/models/email_message.rb +308 -0
- data/lib/purecloudplatformclientv2/models/email_message_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/email_setup.rb +179 -0
- data/lib/purecloudplatformclientv2/models/empty.rb +169 -0
- data/lib/purecloudplatformclientv2/models/encryption_key.rb +228 -0
- data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/endpoint.rb +363 -0
- data/lib/purecloudplatformclientv2/models/endpoint_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/entry.rb +189 -0
- data/lib/purecloudplatformclientv2/models/error_body.rb +265 -0
- data/lib/purecloudplatformclientv2/models/error_details.rb +243 -0
- data/lib/purecloudplatformclientv2/models/estimated_wait_time_predictions.rb +185 -0
- data/lib/purecloudplatformclientv2/models/evaluation.rb +387 -0
- data/lib/purecloudplatformclientv2/models/evaluation_assignment.rb +187 -0
- data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/evaluation_form.rb +270 -0
- data/lib/purecloudplatformclientv2/models/evaluation_form_and_scoring_set.rb +187 -0
- data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/evaluation_scoring_set.rb +225 -0
- data/lib/purecloudplatformclientv2/models/evaluator_activity.rb +261 -0
- data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/expansion_criterium.rb +201 -0
- data/lib/purecloudplatformclientv2/models/export_uri.rb +188 -0
- data/lib/purecloudplatformclientv2/models/export_uri_notification.rb +196 -0
- data/lib/purecloudplatformclientv2/models/extension.rb +351 -0
- data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/extension_pool.rb +320 -0
- data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/external_contact.rb +366 -0
- data/lib/purecloudplatformclientv2/models/external_data_source.rb +204 -0
- data/lib/purecloudplatformclientv2/models/external_organization.rb +349 -0
- data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/facet_entry.rb +257 -0
- data/lib/purecloudplatformclientv2/models/facet_info.rb +191 -0
- data/lib/purecloudplatformclientv2/models/facet_key_attribute.rb +196 -0
- data/lib/purecloudplatformclientv2/models/facet_statistics.rb +234 -0
- data/lib/purecloudplatformclientv2/models/facet_term.rb +224 -0
- data/lib/purecloudplatformclientv2/models/failed_object.rb +205 -0
- data/lib/purecloudplatformclientv2/models/fax_data_v2_notification.rb +322 -0
- data/lib/purecloudplatformclientv2/models/fax_data_v2_notification_lock_data.rb +196 -0
- data/lib/purecloudplatformclientv2/models/fax_data_v2_notification_lock_info.rb +196 -0
- data/lib/purecloudplatformclientv2/models/fax_data_v2_notification_user_data.rb +187 -0
- data/lib/purecloudplatformclientv2/models/fax_data_v2_notification_workspace_data.rb +178 -0
- data/lib/purecloudplatformclientv2/models/fax_document.rb +337 -0
- data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/fax_send_request.rb +278 -0
- data/lib/purecloudplatformclientv2/models/fax_send_response.rb +230 -0
- data/lib/purecloudplatformclientv2/models/fax_status.rb +249 -0
- data/lib/purecloudplatformclientv2/models/fax_summary.rb +196 -0
- data/lib/purecloudplatformclientv2/models/feature_state.rb +178 -0
- data/lib/purecloudplatformclientv2/models/field_config.rb +259 -0
- data/lib/purecloudplatformclientv2/models/field_configs.rb +205 -0
- data/lib/purecloudplatformclientv2/models/field_list.rb +254 -0
- data/lib/purecloudplatformclientv2/models/flow.rb +336 -0
- data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/flow_version.rb +293 -0
- data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/g_suite.rb +243 -0
- data/lib/purecloudplatformclientv2/models/geolocation.rb +274 -0
- data/lib/purecloudplatformclientv2/models/geolocation_notification.rb +214 -0
- data/lib/purecloudplatformclientv2/models/geolocation_settings.rb +216 -0
- data/lib/purecloudplatformclientv2/models/greeting.rb +324 -0
- data/lib/purecloudplatformclientv2/models/greeting_audio_file.rb +196 -0
- data/lib/purecloudplatformclientv2/models/greeting_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/greeting_media_info.rb +197 -0
- data/lib/purecloudplatformclientv2/models/greeting_owner.rb +198 -0
- data/lib/purecloudplatformclientv2/models/group.rb +358 -0
- data/lib/purecloudplatformclientv2/models/group_contact.rb +249 -0
- data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/group_members_update.rb +199 -0
- data/lib/purecloudplatformclientv2/models/group_search_criteria.rb +287 -0
- data/lib/purecloudplatformclientv2/models/group_search_request.rb +234 -0
- data/lib/purecloudplatformclientv2/models/group_update.rb +302 -0
- data/lib/purecloudplatformclientv2/models/groups_search_response.rb +287 -0
- data/lib/purecloudplatformclientv2/models/heart_beat_alert.rb +338 -0
- data/lib/purecloudplatformclientv2/models/heart_beat_alert_container.rb +261 -0
- data/lib/purecloudplatformclientv2/models/heart_beat_alert_notification.rb +277 -0
- data/lib/purecloudplatformclientv2/models/heart_beat_alert_notification_notification_user.rb +187 -0
- data/lib/purecloudplatformclientv2/models/heart_beat_alert_notification_notification_users.rb +187 -0
- data/lib/purecloudplatformclientv2/models/heart_beat_rule.rb +315 -0
- data/lib/purecloudplatformclientv2/models/heart_beat_rule_container.rb +261 -0
- data/lib/purecloudplatformclientv2/models/heart_beat_rule_notification.rb +268 -0
- data/lib/purecloudplatformclientv2/models/heart_beat_rule_notification_notification_user.rb +187 -0
- data/lib/purecloudplatformclientv2/models/identity_now.rb +243 -0
- data/lib/purecloudplatformclientv2/models/import_status.rb +249 -0
- data/lib/purecloudplatformclientv2/models/import_status_notification.rb +237 -0
- data/lib/purecloudplatformclientv2/models/inbound_domain.rb +236 -0
- data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/inbound_route.rb +292 -0
- data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/initiate_screen_recording.rb +196 -0
- data/lib/purecloudplatformclientv2/models/interaction_stat_alert_notification.rb +387 -0
- data/lib/purecloudplatformclientv2/models/interaction_stat_alert_notification_notification_user.rb +187 -0
- data/lib/purecloudplatformclientv2/models/interaction_stat_rule_notification.rb +369 -0
- data/lib/purecloudplatformclientv2/models/interaction_stat_rule_notification_notification_user.rb +187 -0
- data/lib/purecloudplatformclientv2/models/interaction_stats_alert.rb +464 -0
- data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +261 -0
- data/lib/purecloudplatformclientv2/models/interaction_stats_rule.rb +427 -0
- data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +261 -0
- data/lib/purecloudplatformclientv2/models/intraday_data_update_notification.rb +238 -0
- data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_forecast_data_per_interval.rb +196 -0
- data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_historical_agent_data_per_interval.rb +187 -0
- data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_historical_queue_data_per_interval.rb +241 -0
- data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_intraday_data_group.rb +258 -0
- data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_intraday_data_groupings.rb +258 -0
- data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_intraday_forecast_data.rb +196 -0
- data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_intraday_historical_agent_data.rb +187 -0
- data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_intraday_historical_queue_data.rb +241 -0
- data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_intraday_metric.rb +201 -0
- data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_intraday_performance_prediction_agent_data.rb +178 -0
- data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_intraday_performance_prediction_queue_data.rb +196 -0
- data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_intraday_schedule_data.rb +187 -0
- data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_metrics.rb +201 -0
- data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_performance_prediction_agent_data_per_interval.rb +178 -0
- data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_performance_prediction_queue_data_per_interval.rb +196 -0
- data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_schedule_data_per_interval.rb +187 -0
- data/lib/purecloudplatformclientv2/models/json_node.rb +372 -0
- data/lib/purecloudplatformclientv2/models/json_node_search_response.rb +294 -0
- data/lib/purecloudplatformclientv2/models/json_schema_document.rb +237 -0
- data/lib/purecloudplatformclientv2/models/key_rotation_schedule.rb +226 -0
- data/lib/purecloudplatformclientv2/models/keyword.rb +319 -0
- data/lib/purecloudplatformclientv2/models/keyword_set.rb +275 -0
- data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/language.rb +245 -0
- data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/library.rb +231 -0
- data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/license_assignment_request.rb +215 -0
- data/lib/purecloudplatformclientv2/models/license_batch_assignment_request.rb +185 -0
- data/lib/purecloudplatformclientv2/models/license_definition.rb +218 -0
- data/lib/purecloudplatformclientv2/models/license_definition_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/license_organization.rb +209 -0
- data/lib/purecloudplatformclientv2/models/license_update_response.rb +180 -0
- data/lib/purecloudplatformclientv2/models/license_update_status.rb +196 -0
- data/lib/purecloudplatformclientv2/models/license_user.rb +200 -0
- data/lib/purecloudplatformclientv2/models/line.rb +385 -0
- data/lib/purecloudplatformclientv2/models/line_base.rb +320 -0
- data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/line_status.rb +221 -0
- data/lib/purecloudplatformclientv2/models/local_encryption_configuration.rb +240 -0
- data/lib/purecloudplatformclientv2/models/local_encryption_configuration_listing.rb +198 -0
- data/lib/purecloudplatformclientv2/models/local_encryption_key_request.rb +211 -0
- data/lib/purecloudplatformclientv2/models/location.rb +216 -0
- data/lib/purecloudplatformclientv2/models/location_address.rb +232 -0
- data/lib/purecloudplatformclientv2/models/location_definition.rb +269 -0
- data/lib/purecloudplatformclientv2/models/location_emergency_number.rb +211 -0
- data/lib/purecloudplatformclientv2/models/location_search_criteria.rb +287 -0
- data/lib/purecloudplatformclientv2/models/location_search_request.rb +234 -0
- data/lib/purecloudplatformclientv2/models/locations_search_response.rb +287 -0
- data/lib/purecloudplatformclientv2/models/lock_info.rb +221 -0
- data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/management_unit.rb +247 -0
- data/lib/purecloudplatformclientv2/models/max_participants.rb +179 -0
- data/lib/purecloudplatformclientv2/models/media_participant_request.rb +253 -0
- data/lib/purecloudplatformclientv2/models/media_policies.rb +199 -0
- data/lib/purecloudplatformclientv2/models/media_result.rb +189 -0
- data/lib/purecloudplatformclientv2/models/media_setting.rb +187 -0
- data/lib/purecloudplatformclientv2/models/media_summary.rb +187 -0
- data/lib/purecloudplatformclientv2/models/media_summary_detail.rb +187 -0
- data/lib/purecloudplatformclientv2/models/member_entity.rb +178 -0
- data/lib/purecloudplatformclientv2/models/meta_data.rb +198 -0
- data/lib/purecloudplatformclientv2/models/metabase.rb +300 -0
- data/lib/purecloudplatformclientv2/models/metered_evaluation_assignment.rb +225 -0
- data/lib/purecloudplatformclientv2/models/note.rb +253 -0
- data/lib/purecloudplatformclientv2/models/note_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/number.rb +187 -0
- data/lib/purecloudplatformclientv2/models/number_plan.rb +365 -0
- data/lib/purecloudplatformclientv2/models/numeric_range.rb +209 -0
- data/lib/purecloudplatformclientv2/models/o_auth_client.rb +284 -0
- data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/o_auth_client_listing.rb +256 -0
- data/lib/purecloudplatformclientv2/models/o_auth_provider.rb +207 -0
- data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/observation_data_container.rb +192 -0
- data/lib/purecloudplatformclientv2/models/observation_query.rb +195 -0
- data/lib/purecloudplatformclientv2/models/observation_query_response.rb +180 -0
- data/lib/purecloudplatformclientv2/models/okta.rb +234 -0
- data/lib/purecloudplatformclientv2/models/one_login.rb +234 -0
- data/lib/purecloudplatformclientv2/models/operation.rb +284 -0
- data/lib/purecloudplatformclientv2/models/org_media_utilization.rb +201 -0
- data/lib/purecloudplatformclientv2/models/organization.rb +314 -0
- data/lib/purecloudplatformclientv2/models/organization_features.rb +286 -0
- data/lib/purecloudplatformclientv2/models/organization_presence.rb +279 -0
- data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/organization_product_entity_listing.rb +216 -0
- data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/orphan_recording.rb +338 -0
- data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/orphan_update_request.rb +199 -0
- data/lib/purecloudplatformclientv2/models/out_of_office.rb +236 -0
- data/lib/purecloudplatformclientv2/models/out_of_office_notification.rb +214 -0
- data/lib/purecloudplatformclientv2/models/out_of_office_notification_user.rb +178 -0
- data/lib/purecloudplatformclientv2/models/outbound_route.rb +380 -0
- data/lib/purecloudplatformclientv2/models/outbound_route_base.rb +360 -0
- data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/page.rb +249 -0
- data/lib/purecloudplatformclientv2/models/paging_spec.rb +197 -0
- data/lib/purecloudplatformclientv2/models/parameter.rb +233 -0
- data/lib/purecloudplatformclientv2/models/parsed_certificate.rb +182 -0
- data/lib/purecloudplatformclientv2/models/participant.rb +554 -0
- data/lib/purecloudplatformclientv2/models/participant_attributes.rb +181 -0
- data/lib/purecloudplatformclientv2/models/participant_basic.rb +554 -0
- data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/permissions.rb +204 -0
- data/lib/purecloudplatformclientv2/models/phone.rb +440 -0
- data/lib/purecloudplatformclientv2/models/phone_base.rb +350 -0
- data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/phone_capabilities.rb +223 -0
- data/lib/purecloudplatformclientv2/models/phone_column.rb +197 -0
- data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/phone_number.rb +223 -0
- data/lib/purecloudplatformclientv2/models/phone_number_column.rb +187 -0
- data/lib/purecloudplatformclientv2/models/phone_number_status.rb +179 -0
- data/lib/purecloudplatformclientv2/models/phone_status.rb +312 -0
- data/lib/purecloudplatformclientv2/models/phones_reboot.rb +191 -0
- data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/pin_configuration.rb +187 -0
- data/lib/purecloudplatformclientv2/models/ping_identity.rb +243 -0
- data/lib/purecloudplatformclientv2/models/policy.rb +284 -0
- data/lib/purecloudplatformclientv2/models/policy_actions.rb +250 -0
- data/lib/purecloudplatformclientv2/models/policy_conditions.rb +253 -0
- data/lib/purecloudplatformclientv2/models/policy_create.rb +289 -0
- data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/policy_error_message.rb +235 -0
- data/lib/purecloudplatformclientv2/models/policy_errors.rb +180 -0
- data/lib/purecloudplatformclientv2/models/prediction_results.rb +235 -0
- data/lib/purecloudplatformclientv2/models/presence_query_response.rb +192 -0
- data/lib/purecloudplatformclientv2/models/prompt.rb +232 -0
- data/lib/purecloudplatformclientv2/models/prompt_asset.rb +281 -0
- data/lib/purecloudplatformclientv2/models/prompt_asset_create.rb +286 -0
- data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/property_index_request.rb +213 -0
- data/lib/purecloudplatformclientv2/models/provision_info.rb +199 -0
- data/lib/purecloudplatformclientv2/models/pure_cloud.rb +207 -0
- data/lib/purecloudplatformclientv2/models/qualifier_mapping_observation_query_response.rb +192 -0
- data/lib/purecloudplatformclientv2/models/quality_audit.rb +272 -0
- data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +261 -0
- data/lib/purecloudplatformclientv2/models/query_facet_info.rb +191 -0
- data/lib/purecloudplatformclientv2/models/query_request.rb +249 -0
- data/lib/purecloudplatformclientv2/models/query_result.rb +207 -0
- data/lib/purecloudplatformclientv2/models/query_results.rb +187 -0
- data/lib/purecloudplatformclientv2/models/question.rb +279 -0
- data/lib/purecloudplatformclientv2/models/question_group.rb +261 -0
- data/lib/purecloudplatformclientv2/models/question_group_score.rb +270 -0
- data/lib/purecloudplatformclientv2/models/question_score.rb +223 -0
- data/lib/purecloudplatformclientv2/models/queue.rb +423 -0
- data/lib/purecloudplatformclientv2/models/queue_email_address.rb +187 -0
- data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/queue_member.rb +243 -0
- data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/queue_member_notification.rb +205 -0
- data/lib/purecloudplatformclientv2/models/queue_utilization_diagnostic.rb +259 -0
- data/lib/purecloudplatformclientv2/models/reaction.rb +210 -0
- data/lib/purecloudplatformclientv2/models/recall_entry.rb +187 -0
- data/lib/purecloudplatformclientv2/models/recording.rb +418 -0
- data/lib/purecloudplatformclientv2/models/recording_data_v2_notification.rb +322 -0
- data/lib/purecloudplatformclientv2/models/recording_data_v2_notification_conversation_data.rb +178 -0
- data/lib/purecloudplatformclientv2/models/recording_data_v2_notification_lock_data.rb +196 -0
- data/lib/purecloudplatformclientv2/models/recording_data_v2_notification_lock_info.rb +196 -0
- data/lib/purecloudplatformclientv2/models/recording_data_v2_notification_user_data.rb +187 -0
- data/lib/purecloudplatformclientv2/models/recording_data_v2_notification_workspace_data.rb +178 -0
- data/lib/purecloudplatformclientv2/models/recording_email_message.rb +268 -0
- data/lib/purecloudplatformclientv2/models/recording_settings.rb +178 -0
- data/lib/purecloudplatformclientv2/models/relationship.rb +252 -0
- data/lib/purecloudplatformclientv2/models/relationship_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/replace_request.rb +196 -0
- data/lib/purecloudplatformclientv2/models/replace_response.rb +237 -0
- data/lib/purecloudplatformclientv2/models/report_meta_data.rb +258 -0
- data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/report_run_entry.rb +285 -0
- data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/report_schedule.rb +340 -0
- data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/resource_condition_node.rb +246 -0
- data/lib/purecloudplatformclientv2/models/resource_condition_value.rb +201 -0
- data/lib/purecloudplatformclientv2/models/resource_permission_policy.rb +272 -0
- data/lib/purecloudplatformclientv2/models/response.rb +307 -0
- data/lib/purecloudplatformclientv2/models/response_entity_list.rb +262 -0
- data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/response_filter.rb +228 -0
- data/lib/purecloudplatformclientv2/models/response_query_request.rb +202 -0
- data/lib/purecloudplatformclientv2/models/response_query_results.rb +184 -0
- data/lib/purecloudplatformclientv2/models/response_set.rb +244 -0
- data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/response_set_notification.rb +234 -0
- data/lib/purecloudplatformclientv2/models/response_set_notification_reaction.rb +219 -0
- data/lib/purecloudplatformclientv2/models/response_set_notification_responses.rb +219 -0
- data/lib/purecloudplatformclientv2/models/response_substitution.rb +204 -0
- data/lib/purecloudplatformclientv2/models/response_text.rb +208 -0
- data/lib/purecloudplatformclientv2/models/rest_error_detail.rb +193 -0
- data/lib/purecloudplatformclientv2/models/retention_duration.rb +187 -0
- data/lib/purecloudplatformclientv2/models/reverse_whitepages_lookup_result.rb +191 -0
- data/lib/purecloudplatformclientv2/models/ring.rb +189 -0
- data/lib/purecloudplatformclientv2/models/routing_data.rb +227 -0
- data/lib/purecloudplatformclientv2/models/routing_skill.rb +247 -0
- data/lib/purecloudplatformclientv2/models/routing_status.rb +213 -0
- data/lib/purecloudplatformclientv2/models/routing_status_alert.rb +329 -0
- data/lib/purecloudplatformclientv2/models/routing_status_alert_container.rb +261 -0
- data/lib/purecloudplatformclientv2/models/routing_status_rule.rb +315 -0
- data/lib/purecloudplatformclientv2/models/routing_status_rule_container.rb +261 -0
- data/lib/purecloudplatformclientv2/models/rule_set.rb +264 -0
- data/lib/purecloudplatformclientv2/models/rule_set_diagnostic.rb +191 -0
- data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/rule_set_notification.rb +252 -0
- data/lib/purecloudplatformclientv2/models/rule_set_notification_action.rb +216 -0
- data/lib/purecloudplatformclientv2/models/rule_set_notification_actions.rb +216 -0
- data/lib/purecloudplatformclientv2/models/rule_set_notification_condition.rb +271 -0
- data/lib/purecloudplatformclientv2/models/rule_set_notification_conditions.rb +271 -0
- data/lib/purecloudplatformclientv2/models/rule_set_notification_rule.rb +250 -0
- data/lib/purecloudplatformclientv2/models/rule_set_notification_rules.rb +250 -0
- data/lib/purecloudplatformclientv2/models/rule_set_notification_uri_reference.rb +187 -0
- data/lib/purecloudplatformclientv2/models/run_now_response.rb +198 -0
- data/lib/purecloudplatformclientv2/models/salesforce.rb +234 -0
- data/lib/purecloudplatformclientv2/models/schedule_interval.rb +189 -0
- data/lib/purecloudplatformclientv2/models/schema_category.rb +300 -0
- data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/screen_recording_session.rb +236 -0
- data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/screen_recording_session_request.rb +213 -0
- data/lib/purecloudplatformclientv2/models/screen_share_conversation_notification.rb +209 -0
- data/lib/purecloudplatformclientv2/models/screen_share_conversation_notification_detail.rb +205 -0
- data/lib/purecloudplatformclientv2/models/screen_share_conversation_notification_error_body.rb +265 -0
- data/lib/purecloudplatformclientv2/models/screen_share_conversation_notification_error_info.rb +265 -0
- data/lib/purecloudplatformclientv2/models/screen_share_conversation_notification_participants.rb +465 -0
- data/lib/purecloudplatformclientv2/models/screen_share_conversation_notification_screen_share_media_participant.rb +465 -0
- data/lib/purecloudplatformclientv2/models/screen_share_conversation_notification_uri_reference.rb +187 -0
- data/lib/purecloudplatformclientv2/models/screen_share_conversation_notification_wrapup.rb +225 -0
- data/lib/purecloudplatformclientv2/models/screenshare.rb +299 -0
- data/lib/purecloudplatformclientv2/models/script.rb +303 -0
- data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/search_aggregation.rb +245 -0
- data/lib/purecloudplatformclientv2/models/search_criteria.rb +282 -0
- data/lib/purecloudplatformclientv2/models/search_request.rb +287 -0
- data/lib/purecloudplatformclientv2/models/section.rb +207 -0
- data/lib/purecloudplatformclientv2/models/security_profile.rb +209 -0
- data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/segment.rb +227 -0
- data/lib/purecloudplatformclientv2/models/sequence_schedule.rb +272 -0
- data/lib/purecloudplatformclientv2/models/sequence_schedule_notification.rb +252 -0
- data/lib/purecloudplatformclientv2/models/sequence_schedule_notification_schedule_interval.rb +196 -0
- data/lib/purecloudplatformclientv2/models/sequence_schedule_notification_uri_reference.rb +187 -0
- data/lib/purecloudplatformclientv2/models/server_date.rb +179 -0
- data/lib/purecloudplatformclientv2/models/service_context.rb +179 -0
- data/lib/purecloudplatformclientv2/models/service_level.rb +187 -0
- data/lib/purecloudplatformclientv2/models/share.rb +298 -0
- data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/shared_entity.rb +178 -0
- data/lib/purecloudplatformclientv2/models/shared_response.rb +214 -0
- data/lib/purecloudplatformclientv2/models/site.rb +399 -0
- data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/skills_to_remove.rb +196 -0
- data/lib/purecloudplatformclientv2/models/social_conversation_notification.rb +209 -0
- data/lib/purecloudplatformclientv2/models/social_conversation_notification_detail.rb +205 -0
- data/lib/purecloudplatformclientv2/models/social_conversation_notification_error_body.rb +265 -0
- data/lib/purecloudplatformclientv2/models/social_conversation_notification_error_info.rb +265 -0
- data/lib/purecloudplatformclientv2/models/social_conversation_notification_participants.rb +474 -0
- data/lib/purecloudplatformclientv2/models/social_conversation_notification_social_media_participant.rb +474 -0
- data/lib/purecloudplatformclientv2/models/social_conversation_notification_uri_reference.rb +187 -0
- data/lib/purecloudplatformclientv2/models/social_conversation_notification_wrapup.rb +225 -0
- data/lib/purecloudplatformclientv2/models/social_expression.rb +339 -0
- data/lib/purecloudplatformclientv2/models/sort_item.rb +187 -0
- data/lib/purecloudplatformclientv2/models/station.rb +275 -0
- data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/statistical_response.rb +200 -0
- data/lib/purecloudplatformclientv2/models/statistical_summary.rb +250 -0
- data/lib/purecloudplatformclientv2/models/street_address.rb +256 -0
- data/lib/purecloudplatformclientv2/models/subscriber_response.rb +195 -0
- data/lib/purecloudplatformclientv2/models/suggest_search_criteria.rb +259 -0
- data/lib/purecloudplatformclientv2/models/suggest_search_request.rb +213 -0
- data/lib/purecloudplatformclientv2/models/system_presence.rb +198 -0
- data/lib/purecloudplatformclientv2/models/system_prompt.rb +218 -0
- data/lib/purecloudplatformclientv2/models/system_prompt_asset.rb +309 -0
- data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/tag_query_request.rb +196 -0
- data/lib/purecloudplatformclientv2/models/tag_value.rb +223 -0
- data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/term_attribute.rb +210 -0
- data/lib/purecloudplatformclientv2/models/ticker.rb +197 -0
- data/lib/purecloudplatformclientv2/models/time_allowed.rb +198 -0
- data/lib/purecloudplatformclientv2/models/time_interval.rb +187 -0
- data/lib/purecloudplatformclientv2/models/time_off_request.rb +390 -0
- data/lib/purecloudplatformclientv2/models/time_off_request_list.rb +209 -0
- data/lib/purecloudplatformclientv2/models/time_off_request_patch.rb +178 -0
- data/lib/purecloudplatformclientv2/models/time_off_request_update_notification.rb +331 -0
- data/lib/purecloudplatformclientv2/models/time_off_request_update_notification_user.rb +178 -0
- data/lib/purecloudplatformclientv2/models/time_slot.rb +199 -0
- data/lib/purecloudplatformclientv2/models/time_zone.rb +207 -0
- data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/transfer_request.rb +219 -0
- data/lib/purecloudplatformclientv2/models/trunk.rb +384 -0
- data/lib/purecloudplatformclientv2/models/trunk_base.rb +363 -0
- data/lib/purecloudplatformclientv2/models/trunk_base_assignment.rb +189 -0
- data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/trunk_recording_enabled_count.rb +189 -0
- data/lib/purecloudplatformclientv2/models/twitter_id.rb +220 -0
- data/lib/purecloudplatformclientv2/models/unread_metric.rb +179 -0
- data/lib/purecloudplatformclientv2/models/unread_status.rb +179 -0
- data/lib/purecloudplatformclientv2/models/uri_reference.rb +196 -0
- data/lib/purecloudplatformclientv2/models/usage.rb +180 -0
- data/lib/purecloudplatformclientv2/models/usage_item.rb +210 -0
- data/lib/purecloudplatformclientv2/models/user.rb +431 -0
- data/lib/purecloudplatformclientv2/models/user_agent_info.rb +199 -0
- data/lib/purecloudplatformclientv2/models/user_authorization.rb +204 -0
- data/lib/purecloudplatformclientv2/models/user_conversation_summary.rb +232 -0
- data/lib/purecloudplatformclientv2/models/user_conversation_summary_notification.rb +232 -0
- data/lib/purecloudplatformclientv2/models/user_conversation_summary_notification_call.rb +187 -0
- data/lib/purecloudplatformclientv2/models/user_conversation_summary_notification_call_contact_center.rb +187 -0
- data/lib/purecloudplatformclientv2/models/user_conversation_summary_notification_media_summary.rb +187 -0
- data/lib/purecloudplatformclientv2/models/user_conversation_summary_notification_media_summary_detail.rb +187 -0
- data/lib/purecloudplatformclientv2/models/user_details_query.rb +273 -0
- data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/user_image.rb +188 -0
- data/lib/purecloudplatformclientv2/models/user_list_schedule_request_body.rb +214 -0
- data/lib/purecloudplatformclientv2/models/user_me.rb +565 -0
- data/lib/purecloudplatformclientv2/models/user_param.rb +187 -0
- data/lib/purecloudplatformclientv2/models/user_presence.rb +246 -0
- data/lib/purecloudplatformclientv2/models/user_presence_alert.rb +352 -0
- data/lib/purecloudplatformclientv2/models/user_presence_alert_container.rb +261 -0
- data/lib/purecloudplatformclientv2/models/user_presence_notification.rb +205 -0
- data/lib/purecloudplatformclientv2/models/user_presence_notification_organization_presence.rb +187 -0
- data/lib/purecloudplatformclientv2/models/user_presence_notification_presence_definition.rb +187 -0
- data/lib/purecloudplatformclientv2/models/user_presence_rule.rb +329 -0
- data/lib/purecloudplatformclientv2/models/user_presence_rule_container.rb +261 -0
- data/lib/purecloudplatformclientv2/models/user_queue.rb +432 -0
- data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/user_recording.rb +292 -0
- data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/user_routing_skill.rb +243 -0
- data/lib/purecloudplatformclientv2/models/user_routing_skill_post.rb +218 -0
- data/lib/purecloudplatformclientv2/models/user_routing_status_notification.rb +178 -0
- data/lib/purecloudplatformclientv2/models/user_routing_status_notification_routing_status.rb +201 -0
- data/lib/purecloudplatformclientv2/models/user_schedule.rb +194 -0
- data/lib/purecloudplatformclientv2/models/user_schedule_activity.rb +230 -0
- data/lib/purecloudplatformclientv2/models/user_schedule_adherence.rb +392 -0
- data/lib/purecloudplatformclientv2/models/user_schedule_adherence_update_notification.rb +273 -0
- data/lib/purecloudplatformclientv2/models/user_schedule_adherence_update_notification_user.rb +178 -0
- data/lib/purecloudplatformclientv2/models/user_schedule_container.rb +192 -0
- data/lib/purecloudplatformclientv2/models/user_schedule_full_day_time_off_marker.rb +220 -0
- data/lib/purecloudplatformclientv2/models/user_schedule_shift.rb +202 -0
- data/lib/purecloudplatformclientv2/models/user_search_criteria.rb +287 -0
- data/lib/purecloudplatformclientv2/models/user_search_request.rb +246 -0
- data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/user_station.rb +237 -0
- data/lib/purecloudplatformclientv2/models/user_stations.rb +209 -0
- data/lib/purecloudplatformclientv2/models/user_stations_notification.rb +178 -0
- data/lib/purecloudplatformclientv2/models/user_stations_notification_associated_station.rb +196 -0
- data/lib/purecloudplatformclientv2/models/user_stations_notification_user.rb +178 -0
- data/lib/purecloudplatformclientv2/models/user_stations_notification_user_station.rb +196 -0
- data/lib/purecloudplatformclientv2/models/users_search_response.rb +287 -0
- data/lib/purecloudplatformclientv2/models/utilization.rb +181 -0
- data/lib/purecloudplatformclientv2/models/validate_address_request.rb +179 -0
- data/lib/purecloudplatformclientv2/models/validate_address_response.rb +193 -0
- data/lib/purecloudplatformclientv2/models/video.rb +307 -0
- data/lib/purecloudplatformclientv2/models/video_conversation_notification.rb +209 -0
- data/lib/purecloudplatformclientv2/models/video_conversation_notification_detail.rb +205 -0
- data/lib/purecloudplatformclientv2/models/video_conversation_notification_error_body.rb +265 -0
- data/lib/purecloudplatformclientv2/models/video_conversation_notification_error_info.rb +265 -0
- data/lib/purecloudplatformclientv2/models/video_conversation_notification_participants.rb +483 -0
- data/lib/purecloudplatformclientv2/models/video_conversation_notification_uri_reference.rb +187 -0
- data/lib/purecloudplatformclientv2/models/video_conversation_notification_video_media_participant.rb +483 -0
- data/lib/purecloudplatformclientv2/models/video_conversation_notification_wrapup.rb +225 -0
- data/lib/purecloudplatformclientv2/models/visibility_condition.rb +204 -0
- data/lib/purecloudplatformclientv2/models/vm_pairing_info.rb +206 -0
- data/lib/purecloudplatformclientv2/models/voicemail_copy_record.rb +199 -0
- data/lib/purecloudplatformclientv2/models/voicemail_group_policy.rb +228 -0
- data/lib/purecloudplatformclientv2/models/voicemail_mailbox_info.rb +229 -0
- data/lib/purecloudplatformclientv2/models/voicemail_media_info.rb +197 -0
- data/lib/purecloudplatformclientv2/models/voicemail_message.rb +341 -0
- data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/voicemail_message_notification.rb +277 -0
- data/lib/purecloudplatformclientv2/models/voicemail_organization_policy.rb +239 -0
- data/lib/purecloudplatformclientv2/models/voicemail_search_criteria.rb +287 -0
- data/lib/purecloudplatformclientv2/models/voicemail_search_request.rb +246 -0
- data/lib/purecloudplatformclientv2/models/voicemail_user_policy.rb +209 -0
- data/lib/purecloudplatformclientv2/models/voicemails_search_response.rb +287 -0
- data/lib/purecloudplatformclientv2/models/wfm_user_entity_listing.rb +180 -0
- data/lib/purecloudplatformclientv2/models/workspace.rb +302 -0
- data/lib/purecloudplatformclientv2/models/workspace_create.rb +201 -0
- data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/workspace_member.rb +271 -0
- data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/models/workspace_summary.rb +187 -0
- data/lib/purecloudplatformclientv2/models/wrap_up_code_mapping.rb +252 -0
- data/lib/purecloudplatformclientv2/models/wrap_up_code_mapping_notification.rb +236 -0
- data/lib/purecloudplatformclientv2/models/wrapup.rb +241 -0
- data/lib/purecloudplatformclientv2/models/wrapup_code.rb +241 -0
- data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +261 -0
- data/lib/purecloudplatformclientv2/version.rb +19 -0
- data/purecloudplatformclientv2.gemspec +32 -0
- data/spec/api_client_spec.rb +273 -0
- data/spec/configuration_spec.rb +25 -0
- data/spec/spec_helper.rb +99 -0
- metadata +2050 -0
|
@@ -0,0 +1,4864 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ConversationsApi
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
## PureCloud::ConversationsApi
|
|
6
|
+
|
|
7
|
+
All URIs are relative to *https://api.mypurecloud.com*
|
|
8
|
+
|
|
9
|
+
Method | Description
|
|
10
|
+
------------- | ------------- | -------------
|
|
11
|
+
[**delete_conversation_participant_code**](ConversationsApi.html#delete_conversation_participant_code) | Delete a code used to add a communication to this participant
|
|
12
|
+
[**delete_conversations_call_participant_consult**](ConversationsApi.html#delete_conversations_call_participant_consult) | Cancel the transfer
|
|
13
|
+
[**delete_conversations_email_messages_draft_attachment**](ConversationsApi.html#delete_conversations_email_messages_draft_attachment) | Delete attachment from draft
|
|
14
|
+
[**get_analytics_conversation_details**](ConversationsApi.html#get_analytics_conversation_details) | Get a conversation by id
|
|
15
|
+
[**get_conversation**](ConversationsApi.html#get_conversation) | Get conversation
|
|
16
|
+
[**get_conversation_participant_wrapup**](ConversationsApi.html#get_conversation_participant_wrapup) | Get the wrap-up for this conversation participant.
|
|
17
|
+
[**get_conversation_participant_wrapupcodes**](ConversationsApi.html#get_conversation_participant_wrapupcodes) | Get list of wrapup codes for this conversation participant
|
|
18
|
+
[**get_conversations**](ConversationsApi.html#get_conversations) | Get conversations
|
|
19
|
+
[**get_conversations_call**](ConversationsApi.html#get_conversations_call) | Get call conversation
|
|
20
|
+
[**get_conversations_call_participant_wrapup**](ConversationsApi.html#get_conversations_call_participant_wrapup) | Get the wrap-up for this conversation participant.
|
|
21
|
+
[**get_conversations_call_participant_wrapupcodes**](ConversationsApi.html#get_conversations_call_participant_wrapupcodes) | Get list of wrapup codes for this conversation participant
|
|
22
|
+
[**get_conversations_callback**](ConversationsApi.html#get_conversations_callback) | Get callback conversation
|
|
23
|
+
[**get_conversations_callback_participant_wrapup**](ConversationsApi.html#get_conversations_callback_participant_wrapup) | Get the wrap-up for this conversation participant.
|
|
24
|
+
[**get_conversations_callback_participant_wrapupcodes**](ConversationsApi.html#get_conversations_callback_participant_wrapupcodes) | Get list of wrapup codes for this conversation participant
|
|
25
|
+
[**get_conversations_callbacks**](ConversationsApi.html#get_conversations_callbacks) | Get callback conversations
|
|
26
|
+
[**get_conversations_calls**](ConversationsApi.html#get_conversations_calls) | Get recent conversations
|
|
27
|
+
[**get_conversations_calls_history**](ConversationsApi.html#get_conversations_calls_history) | Get call history
|
|
28
|
+
[**get_conversations_calls_maximumconferenceparties**](ConversationsApi.html#get_conversations_calls_maximumconferenceparties) | Get the maximum number of participants that this user can have on a conference
|
|
29
|
+
[**get_conversations_chat**](ConversationsApi.html#get_conversations_chat) | Get chat conversation
|
|
30
|
+
[**get_conversations_chat_participant_wrapup**](ConversationsApi.html#get_conversations_chat_participant_wrapup) | Get the wrap-up for this conversation participant.
|
|
31
|
+
[**get_conversations_chat_participant_wrapupcodes**](ConversationsApi.html#get_conversations_chat_participant_wrapupcodes) | Get list of wrapup codes for this conversation participant
|
|
32
|
+
[**get_conversations_chats**](ConversationsApi.html#get_conversations_chats) | Get recent chat conversations
|
|
33
|
+
[**get_conversations_cobrowsesession**](ConversationsApi.html#get_conversations_cobrowsesession) | Get cobrowse conversation
|
|
34
|
+
[**get_conversations_cobrowsesession_participant_wrapup**](ConversationsApi.html#get_conversations_cobrowsesession_participant_wrapup) | Get the wrap-up for this conversation participant.
|
|
35
|
+
[**get_conversations_cobrowsesession_participant_wrapupcodes**](ConversationsApi.html#get_conversations_cobrowsesession_participant_wrapupcodes) | Get list of wrapup codes for this conversation participant
|
|
36
|
+
[**get_conversations_cobrowsesessions**](ConversationsApi.html#get_conversations_cobrowsesessions) | Get recent cobrowse conversations
|
|
37
|
+
[**get_conversations_email**](ConversationsApi.html#get_conversations_email) | Get email conversation
|
|
38
|
+
[**get_conversations_email_message**](ConversationsApi.html#get_conversations_email_message) | Get conversation message
|
|
39
|
+
[**get_conversations_email_messages**](ConversationsApi.html#get_conversations_email_messages) | Get conversation messages
|
|
40
|
+
[**get_conversations_email_messages_draft**](ConversationsApi.html#get_conversations_email_messages_draft) | Get conversation draft reply
|
|
41
|
+
[**get_conversations_email_participant_wrapup**](ConversationsApi.html#get_conversations_email_participant_wrapup) | Get the wrap-up for this conversation participant.
|
|
42
|
+
[**get_conversations_email_participant_wrapupcodes**](ConversationsApi.html#get_conversations_email_participant_wrapupcodes) | Get list of wrapup codes for this conversation participant
|
|
43
|
+
[**get_conversations_emails**](ConversationsApi.html#get_conversations_emails) | Get recent email conversations
|
|
44
|
+
[**patch_conversation_participant**](ConversationsApi.html#patch_conversation_participant) | Update a participant.
|
|
45
|
+
[**patch_conversation_participant_attributes**](ConversationsApi.html#patch_conversation_participant_attributes) | Update the attributes on a conversation participant.
|
|
46
|
+
[**patch_conversations_call**](ConversationsApi.html#patch_conversations_call) | Update a conversation by setting it's recording state, merging in other conversations to create a conference, or disconnecting all of the participants
|
|
47
|
+
[**patch_conversations_call_participant**](ConversationsApi.html#patch_conversations_call_participant) | Update conversation participant
|
|
48
|
+
[**patch_conversations_call_participant_attributes**](ConversationsApi.html#patch_conversations_call_participant_attributes) | Update the attributes on a conversation participant.
|
|
49
|
+
[**patch_conversations_call_participant_communication**](ConversationsApi.html#patch_conversations_call_participant_communication) | Update conversation participant's communication by disconnecting it.
|
|
50
|
+
[**patch_conversations_call_participant_consult**](ConversationsApi.html#patch_conversations_call_participant_consult) | Change who can speak
|
|
51
|
+
[**patch_conversations_callback**](ConversationsApi.html#patch_conversations_callback) | Update a conversation by disconnecting all of the participants
|
|
52
|
+
[**patch_conversations_callback_participant**](ConversationsApi.html#patch_conversations_callback_participant) | Update conversation participant
|
|
53
|
+
[**patch_conversations_callback_participant_attributes**](ConversationsApi.html#patch_conversations_callback_participant_attributes) | Update the attributes on a conversation participant.
|
|
54
|
+
[**patch_conversations_callback_participant_communication**](ConversationsApi.html#patch_conversations_callback_participant_communication) | Update conversation participant's communication by disconnecting it.
|
|
55
|
+
[**patch_conversations_chat**](ConversationsApi.html#patch_conversations_chat) | Update a conversation by disconnecting all of the participants
|
|
56
|
+
[**patch_conversations_chat_participant**](ConversationsApi.html#patch_conversations_chat_participant) | Update conversation participant
|
|
57
|
+
[**patch_conversations_chat_participant_attributes**](ConversationsApi.html#patch_conversations_chat_participant_attributes) | Update the attributes on a conversation participant.
|
|
58
|
+
[**patch_conversations_chat_participant_communication**](ConversationsApi.html#patch_conversations_chat_participant_communication) | Update conversation participant's communication by disconnecting it.
|
|
59
|
+
[**patch_conversations_cobrowsesession**](ConversationsApi.html#patch_conversations_cobrowsesession) | Update a conversation by disconnecting all of the participants
|
|
60
|
+
[**patch_conversations_cobrowsesession_participant**](ConversationsApi.html#patch_conversations_cobrowsesession_participant) | Update conversation participant
|
|
61
|
+
[**patch_conversations_cobrowsesession_participant_attributes**](ConversationsApi.html#patch_conversations_cobrowsesession_participant_attributes) | Update the attributes on a conversation participant.
|
|
62
|
+
[**patch_conversations_cobrowsesession_participant_communication**](ConversationsApi.html#patch_conversations_cobrowsesession_participant_communication) | Update conversation participant's communication by disconnecting it.
|
|
63
|
+
[**patch_conversations_email**](ConversationsApi.html#patch_conversations_email) | Update a conversation by disconnecting all of the participants
|
|
64
|
+
[**patch_conversations_email_participant**](ConversationsApi.html#patch_conversations_email_participant) | Update conversation participant
|
|
65
|
+
[**patch_conversations_email_participant_attributes**](ConversationsApi.html#patch_conversations_email_participant_attributes) | Update the attributes on a conversation participant.
|
|
66
|
+
[**patch_conversations_email_participant_communication**](ConversationsApi.html#patch_conversations_email_participant_communication) | Update conversation participant's communication by disconnecting it.
|
|
67
|
+
[**post_analytics_conversation_details_properties**](ConversationsApi.html#post_analytics_conversation_details_properties) | Index conversation properties
|
|
68
|
+
[**post_analytics_conversations_aggregates_query**](ConversationsApi.html#post_analytics_conversations_aggregates_query) | Query for conversation aggregates
|
|
69
|
+
[**post_analytics_conversations_details_query**](ConversationsApi.html#post_analytics_conversations_details_query) | Query for conversation details
|
|
70
|
+
[**post_conversation_participant_callbacks**](ConversationsApi.html#post_conversation_participant_callbacks) | Create a new callback for the specified participant on the conversation.
|
|
71
|
+
[**post_conversation_participant_replace**](ConversationsApi.html#post_conversation_participant_replace) | Replace this participant with the specified user and/or address
|
|
72
|
+
[**post_conversations_call**](ConversationsApi.html#post_conversations_call) | Add a new call to a conversation
|
|
73
|
+
[**post_conversations_call_participant_consult**](ConversationsApi.html#post_conversations_call_participant_consult) | Initiate and update consult transfer
|
|
74
|
+
[**post_conversations_call_participant_monitor**](ConversationsApi.html#post_conversations_call_participant_monitor) | Listen in on the conversation from the point of view of a given participant.
|
|
75
|
+
[**post_conversations_call_participant_replace**](ConversationsApi.html#post_conversations_call_participant_replace) | Replace this participant with the specified user and/or address
|
|
76
|
+
[**post_conversations_call_participants**](ConversationsApi.html#post_conversations_call_participants) | Add participants to a conversation
|
|
77
|
+
[**post_conversations_callback_participant_replace**](ConversationsApi.html#post_conversations_callback_participant_replace) | Replace this participant with the specified user and/or address
|
|
78
|
+
[**post_conversations_callbacks**](ConversationsApi.html#post_conversations_callbacks) | Create a Callback
|
|
79
|
+
[**post_conversations_calls**](ConversationsApi.html#post_conversations_calls) | Create a call conversation
|
|
80
|
+
[**post_conversations_chat_participant_replace**](ConversationsApi.html#post_conversations_chat_participant_replace) | Replace this participant with the specified user and/or address
|
|
81
|
+
[**post_conversations_chats**](ConversationsApi.html#post_conversations_chats) | Create a web chat conversation
|
|
82
|
+
[**post_conversations_cobrowsesession_participant_replace**](ConversationsApi.html#post_conversations_cobrowsesession_participant_replace) | Replace this participant with the specified user and/or address
|
|
83
|
+
[**post_conversations_email_messages**](ConversationsApi.html#post_conversations_email_messages) | Send an email reply
|
|
84
|
+
[**post_conversations_email_participant_replace**](ConversationsApi.html#post_conversations_email_participant_replace) | Replace this participant with the specified user and/or address
|
|
85
|
+
[**post_conversations_emails**](ConversationsApi.html#post_conversations_emails) | Create an email conversation
|
|
86
|
+
[**post_conversations_faxes**](ConversationsApi.html#post_conversations_faxes) | Create Fax Conversation
|
|
87
|
+
[**put_conversations_email_messages_draft**](ConversationsApi.html#put_conversations_email_messages_draft) | Update conversation draft reply
|
|
88
|
+
{: class="table table-striped"}
|
|
89
|
+
|
|
90
|
+
<a name="delete_conversation_participant_code"></a>
|
|
91
|
+
|
|
92
|
+
## - delete_conversation_participant_code(conversation_id, participant_id, add_communication_code)
|
|
93
|
+
|
|
94
|
+
Delete a code used to add a communication to this participant
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
Wraps DELETE /api/v2/conversations/{conversationId}/participants/{participantId}/codes/{addCommunicationCode}
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
### Example
|
|
102
|
+
~~~ruby
|
|
103
|
+
# load the gem
|
|
104
|
+
require 'purecloudplatformclientv2'
|
|
105
|
+
# setup authorization
|
|
106
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
107
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
108
|
+
environment = "mypurecloud.com"
|
|
109
|
+
|
|
110
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
111
|
+
|
|
112
|
+
PureCloud.configure do |config|
|
|
113
|
+
config.access_token = @authToken
|
|
114
|
+
end
|
|
115
|
+
|
|
116
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
117
|
+
|
|
118
|
+
conversation_id = "conversation_id_example" # String | conversation ID
|
|
119
|
+
|
|
120
|
+
participant_id = "participant_id_example" # String | participant ID
|
|
121
|
+
|
|
122
|
+
add_communication_code = "add_communication_code_example" # String | addCommunicationCode
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
begin
|
|
126
|
+
#Delete a code used to add a communication to this participant
|
|
127
|
+
api_instance.delete_conversation_participant_code(conversation_id, participant_id, add_communication_code)
|
|
128
|
+
rescue PureCloud::ApiError => e
|
|
129
|
+
puts "Exception when calling ConversationsApi->delete_conversation_participant_code: #{e}"
|
|
130
|
+
end
|
|
131
|
+
~~~
|
|
132
|
+
|
|
133
|
+
### Parameters
|
|
134
|
+
|
|
135
|
+
Name | Type | Description | Notes
|
|
136
|
+
------------- | ------------- | ------------- | -------------
|
|
137
|
+
**conversation_id** | **String**| conversation ID |
|
|
138
|
+
**participant_id** | **String**| participant ID |
|
|
139
|
+
**add_communication_code** | **String**| addCommunicationCode |
|
|
140
|
+
{: class="table table-striped"}
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
### Return type
|
|
144
|
+
|
|
145
|
+
nil (empty response body)
|
|
146
|
+
|
|
147
|
+
### HTTP request headers
|
|
148
|
+
|
|
149
|
+
- **Content-Type**: application/json
|
|
150
|
+
- **Accept**: application/json
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
<a name="delete_conversations_call_participant_consult"></a>
|
|
155
|
+
|
|
156
|
+
## -String** delete_conversations_call_participant_consult(call_id, participant_id)
|
|
157
|
+
|
|
158
|
+
Cancel the transfer
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
Wraps DELETE /api/v2/conversations/calls/{callId}/participants/{participantId}/consult
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
### Example
|
|
166
|
+
~~~ruby
|
|
167
|
+
# load the gem
|
|
168
|
+
require 'purecloudplatformclientv2'
|
|
169
|
+
# setup authorization
|
|
170
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
171
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
172
|
+
environment = "mypurecloud.com"
|
|
173
|
+
|
|
174
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
175
|
+
|
|
176
|
+
PureCloud.configure do |config|
|
|
177
|
+
config.access_token = @authToken
|
|
178
|
+
end
|
|
179
|
+
|
|
180
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
181
|
+
|
|
182
|
+
call_id = "call_id_example" # String | callId
|
|
183
|
+
|
|
184
|
+
participant_id = "participant_id_example" # String | participantId
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
begin
|
|
188
|
+
#Cancel the transfer
|
|
189
|
+
result = api_instance.delete_conversations_call_participant_consult(call_id, participant_id)
|
|
190
|
+
p result
|
|
191
|
+
rescue PureCloud::ApiError => e
|
|
192
|
+
puts "Exception when calling ConversationsApi->delete_conversations_call_participant_consult: #{e}"
|
|
193
|
+
end
|
|
194
|
+
~~~
|
|
195
|
+
|
|
196
|
+
### Parameters
|
|
197
|
+
|
|
198
|
+
Name | Type | Description | Notes
|
|
199
|
+
------------- | ------------- | ------------- | -------------
|
|
200
|
+
**call_id** | **String**| callId |
|
|
201
|
+
**participant_id** | **String**| participantId |
|
|
202
|
+
{: class="table table-striped"}
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
### Return type
|
|
206
|
+
|
|
207
|
+
**String**
|
|
208
|
+
|
|
209
|
+
### HTTP request headers
|
|
210
|
+
|
|
211
|
+
- **Content-Type**: application/json
|
|
212
|
+
- **Accept**: application/json
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
<a name="delete_conversations_email_messages_draft_attachment"></a>
|
|
217
|
+
|
|
218
|
+
## -String** delete_conversations_email_messages_draft_attachment(email_id, attachment_id)
|
|
219
|
+
|
|
220
|
+
Delete attachment from draft
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
Wraps DELETE /api/v2/conversations/emails/{emailId}/messages/draft/attachments/{attachmentId}
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
### Example
|
|
228
|
+
~~~ruby
|
|
229
|
+
# load the gem
|
|
230
|
+
require 'purecloudplatformclientv2'
|
|
231
|
+
# setup authorization
|
|
232
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
233
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
234
|
+
environment = "mypurecloud.com"
|
|
235
|
+
|
|
236
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
237
|
+
|
|
238
|
+
PureCloud.configure do |config|
|
|
239
|
+
config.access_token = @authToken
|
|
240
|
+
end
|
|
241
|
+
|
|
242
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
243
|
+
|
|
244
|
+
email_id = "email_id_example" # String | emailId
|
|
245
|
+
|
|
246
|
+
attachment_id = "attachment_id_example" # String | attachmentId
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
begin
|
|
250
|
+
#Delete attachment from draft
|
|
251
|
+
result = api_instance.delete_conversations_email_messages_draft_attachment(email_id, attachment_id)
|
|
252
|
+
p result
|
|
253
|
+
rescue PureCloud::ApiError => e
|
|
254
|
+
puts "Exception when calling ConversationsApi->delete_conversations_email_messages_draft_attachment: #{e}"
|
|
255
|
+
end
|
|
256
|
+
~~~
|
|
257
|
+
|
|
258
|
+
### Parameters
|
|
259
|
+
|
|
260
|
+
Name | Type | Description | Notes
|
|
261
|
+
------------- | ------------- | ------------- | -------------
|
|
262
|
+
**email_id** | **String**| emailId |
|
|
263
|
+
**attachment_id** | **String**| attachmentId |
|
|
264
|
+
{: class="table table-striped"}
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
### Return type
|
|
268
|
+
|
|
269
|
+
**String**
|
|
270
|
+
|
|
271
|
+
### HTTP request headers
|
|
272
|
+
|
|
273
|
+
- **Content-Type**: application/json
|
|
274
|
+
- **Accept**: application/json
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
<a name="get_analytics_conversation_details"></a>
|
|
279
|
+
|
|
280
|
+
## -[**AnalyticsConversation**](AnalyticsConversation.html) get_analytics_conversation_details(conversation_id)
|
|
281
|
+
|
|
282
|
+
Get a conversation by id
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
Wraps GET /api/v2/analytics/conversations/{conversationId}/details
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
### Example
|
|
290
|
+
~~~ruby
|
|
291
|
+
# load the gem
|
|
292
|
+
require 'purecloudplatformclientv2'
|
|
293
|
+
# setup authorization
|
|
294
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
295
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
296
|
+
environment = "mypurecloud.com"
|
|
297
|
+
|
|
298
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
299
|
+
|
|
300
|
+
PureCloud.configure do |config|
|
|
301
|
+
config.access_token = @authToken
|
|
302
|
+
end
|
|
303
|
+
|
|
304
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
305
|
+
|
|
306
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
begin
|
|
310
|
+
#Get a conversation by id
|
|
311
|
+
result = api_instance.get_analytics_conversation_details(conversation_id)
|
|
312
|
+
p result
|
|
313
|
+
rescue PureCloud::ApiError => e
|
|
314
|
+
puts "Exception when calling ConversationsApi->get_analytics_conversation_details: #{e}"
|
|
315
|
+
end
|
|
316
|
+
~~~
|
|
317
|
+
|
|
318
|
+
### Parameters
|
|
319
|
+
|
|
320
|
+
Name | Type | Description | Notes
|
|
321
|
+
------------- | ------------- | ------------- | -------------
|
|
322
|
+
**conversation_id** | **String**| conversationId |
|
|
323
|
+
{: class="table table-striped"}
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
### Return type
|
|
327
|
+
|
|
328
|
+
[**AnalyticsConversation**](AnalyticsConversation.html)
|
|
329
|
+
|
|
330
|
+
### HTTP request headers
|
|
331
|
+
|
|
332
|
+
- **Content-Type**: application/json
|
|
333
|
+
- **Accept**: application/json
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
<a name="get_conversation"></a>
|
|
338
|
+
|
|
339
|
+
## -[**Conversation**](Conversation.html) get_conversation(conversation_id)
|
|
340
|
+
|
|
341
|
+
Get conversation
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
Wraps GET /api/v2/conversations/{conversationId}
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
### Example
|
|
349
|
+
~~~ruby
|
|
350
|
+
# load the gem
|
|
351
|
+
require 'purecloudplatformclientv2'
|
|
352
|
+
# setup authorization
|
|
353
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
354
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
355
|
+
environment = "mypurecloud.com"
|
|
356
|
+
|
|
357
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
358
|
+
|
|
359
|
+
PureCloud.configure do |config|
|
|
360
|
+
config.access_token = @authToken
|
|
361
|
+
end
|
|
362
|
+
|
|
363
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
364
|
+
|
|
365
|
+
conversation_id = "conversation_id_example" # String | conversation ID
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
begin
|
|
369
|
+
#Get conversation
|
|
370
|
+
result = api_instance.get_conversation(conversation_id)
|
|
371
|
+
p result
|
|
372
|
+
rescue PureCloud::ApiError => e
|
|
373
|
+
puts "Exception when calling ConversationsApi->get_conversation: #{e}"
|
|
374
|
+
end
|
|
375
|
+
~~~
|
|
376
|
+
|
|
377
|
+
### Parameters
|
|
378
|
+
|
|
379
|
+
Name | Type | Description | Notes
|
|
380
|
+
------------- | ------------- | ------------- | -------------
|
|
381
|
+
**conversation_id** | **String**| conversation ID |
|
|
382
|
+
{: class="table table-striped"}
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
### Return type
|
|
386
|
+
|
|
387
|
+
[**Conversation**](Conversation.html)
|
|
388
|
+
|
|
389
|
+
### HTTP request headers
|
|
390
|
+
|
|
391
|
+
- **Content-Type**: application/json
|
|
392
|
+
- **Accept**: application/json
|
|
393
|
+
|
|
394
|
+
|
|
395
|
+
|
|
396
|
+
<a name="get_conversation_participant_wrapup"></a>
|
|
397
|
+
|
|
398
|
+
## -[**WrapupCode**](WrapupCode.html) get_conversation_participant_wrapup(conversation_id, participant_id, opts)
|
|
399
|
+
|
|
400
|
+
Get the wrap-up for this conversation participant.
|
|
401
|
+
|
|
402
|
+
|
|
403
|
+
|
|
404
|
+
Wraps GET /api/v2/conversations/{conversationId}/participants/{participantId}/wrapup
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
### Example
|
|
408
|
+
~~~ruby
|
|
409
|
+
# load the gem
|
|
410
|
+
require 'purecloudplatformclientv2'
|
|
411
|
+
# setup authorization
|
|
412
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
413
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
414
|
+
environment = "mypurecloud.com"
|
|
415
|
+
|
|
416
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
417
|
+
|
|
418
|
+
PureCloud.configure do |config|
|
|
419
|
+
config.access_token = @authToken
|
|
420
|
+
end
|
|
421
|
+
|
|
422
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
423
|
+
|
|
424
|
+
conversation_id = "conversation_id_example" # String | conversation ID
|
|
425
|
+
|
|
426
|
+
participant_id = "participant_id_example" # String | participant ID
|
|
427
|
+
|
|
428
|
+
opts = {
|
|
429
|
+
provisional: false # BOOLEAN | Indicates if the wrap-up code is provisional.
|
|
430
|
+
}
|
|
431
|
+
|
|
432
|
+
begin
|
|
433
|
+
#Get the wrap-up for this conversation participant.
|
|
434
|
+
result = api_instance.get_conversation_participant_wrapup(conversation_id, participant_id, opts)
|
|
435
|
+
p result
|
|
436
|
+
rescue PureCloud::ApiError => e
|
|
437
|
+
puts "Exception when calling ConversationsApi->get_conversation_participant_wrapup: #{e}"
|
|
438
|
+
end
|
|
439
|
+
~~~
|
|
440
|
+
|
|
441
|
+
### Parameters
|
|
442
|
+
|
|
443
|
+
Name | Type | Description | Notes
|
|
444
|
+
------------- | ------------- | ------------- | -------------
|
|
445
|
+
**conversation_id** | **String**| conversation ID |
|
|
446
|
+
**participant_id** | **String**| participant ID |
|
|
447
|
+
**provisional** | **BOOLEAN**| Indicates if the wrap-up code is provisional. | [optional] [default to false]
|
|
448
|
+
{: class="table table-striped"}
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
### Return type
|
|
452
|
+
|
|
453
|
+
[**WrapupCode**](WrapupCode.html)
|
|
454
|
+
|
|
455
|
+
### HTTP request headers
|
|
456
|
+
|
|
457
|
+
- **Content-Type**: application/json
|
|
458
|
+
- **Accept**: application/json
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
<a name="get_conversation_participant_wrapupcodes"></a>
|
|
463
|
+
|
|
464
|
+
## -[**Array<WrapupCode>**](WrapupCode.html) get_conversation_participant_wrapupcodes(conversation_id, participant_id)
|
|
465
|
+
|
|
466
|
+
Get list of wrapup codes for this conversation participant
|
|
467
|
+
|
|
468
|
+
|
|
469
|
+
|
|
470
|
+
Wraps GET /api/v2/conversations/{conversationId}/participants/{participantId}/wrapupcodes
|
|
471
|
+
|
|
472
|
+
|
|
473
|
+
### Example
|
|
474
|
+
~~~ruby
|
|
475
|
+
# load the gem
|
|
476
|
+
require 'purecloudplatformclientv2'
|
|
477
|
+
# setup authorization
|
|
478
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
479
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
480
|
+
environment = "mypurecloud.com"
|
|
481
|
+
|
|
482
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
483
|
+
|
|
484
|
+
PureCloud.configure do |config|
|
|
485
|
+
config.access_token = @authToken
|
|
486
|
+
end
|
|
487
|
+
|
|
488
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
489
|
+
|
|
490
|
+
conversation_id = "conversation_id_example" # String | conversation ID
|
|
491
|
+
|
|
492
|
+
participant_id = "participant_id_example" # String | participant ID
|
|
493
|
+
|
|
494
|
+
|
|
495
|
+
begin
|
|
496
|
+
#Get list of wrapup codes for this conversation participant
|
|
497
|
+
result = api_instance.get_conversation_participant_wrapupcodes(conversation_id, participant_id)
|
|
498
|
+
p result
|
|
499
|
+
rescue PureCloud::ApiError => e
|
|
500
|
+
puts "Exception when calling ConversationsApi->get_conversation_participant_wrapupcodes: #{e}"
|
|
501
|
+
end
|
|
502
|
+
~~~
|
|
503
|
+
|
|
504
|
+
### Parameters
|
|
505
|
+
|
|
506
|
+
Name | Type | Description | Notes
|
|
507
|
+
------------- | ------------- | ------------- | -------------
|
|
508
|
+
**conversation_id** | **String**| conversation ID |
|
|
509
|
+
**participant_id** | **String**| participant ID |
|
|
510
|
+
{: class="table table-striped"}
|
|
511
|
+
|
|
512
|
+
|
|
513
|
+
### Return type
|
|
514
|
+
|
|
515
|
+
[**Array<WrapupCode>**](WrapupCode.html)
|
|
516
|
+
|
|
517
|
+
### HTTP request headers
|
|
518
|
+
|
|
519
|
+
- **Content-Type**: application/json
|
|
520
|
+
- **Accept**: application/json
|
|
521
|
+
|
|
522
|
+
|
|
523
|
+
|
|
524
|
+
<a name="get_conversations"></a>
|
|
525
|
+
|
|
526
|
+
## -[**ConversationEntityListing**](ConversationEntityListing.html) get_conversations(opts)
|
|
527
|
+
|
|
528
|
+
Get conversations
|
|
529
|
+
|
|
530
|
+
|
|
531
|
+
|
|
532
|
+
Wraps GET /api/v2/conversations
|
|
533
|
+
|
|
534
|
+
|
|
535
|
+
### Example
|
|
536
|
+
~~~ruby
|
|
537
|
+
# load the gem
|
|
538
|
+
require 'purecloudplatformclientv2'
|
|
539
|
+
# setup authorization
|
|
540
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
541
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
542
|
+
environment = "mypurecloud.com"
|
|
543
|
+
|
|
544
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
545
|
+
|
|
546
|
+
PureCloud.configure do |config|
|
|
547
|
+
config.access_token = @authToken
|
|
548
|
+
end
|
|
549
|
+
|
|
550
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
551
|
+
|
|
552
|
+
opts = {
|
|
553
|
+
communication_type: "communication_type_example" # String | Call or Chat communication filtering
|
|
554
|
+
}
|
|
555
|
+
|
|
556
|
+
begin
|
|
557
|
+
#Get conversations
|
|
558
|
+
result = api_instance.get_conversations(opts)
|
|
559
|
+
p result
|
|
560
|
+
rescue PureCloud::ApiError => e
|
|
561
|
+
puts "Exception when calling ConversationsApi->get_conversations: #{e}"
|
|
562
|
+
end
|
|
563
|
+
~~~
|
|
564
|
+
|
|
565
|
+
### Parameters
|
|
566
|
+
|
|
567
|
+
Name | Type | Description | Notes
|
|
568
|
+
------------- | ------------- | ------------- | -------------
|
|
569
|
+
**communication_type** | **String**| Call or Chat communication filtering | [optional]
|
|
570
|
+
{: class="table table-striped"}
|
|
571
|
+
|
|
572
|
+
|
|
573
|
+
### Return type
|
|
574
|
+
|
|
575
|
+
[**ConversationEntityListing**](ConversationEntityListing.html)
|
|
576
|
+
|
|
577
|
+
### HTTP request headers
|
|
578
|
+
|
|
579
|
+
- **Content-Type**: application/json
|
|
580
|
+
- **Accept**: application/json
|
|
581
|
+
|
|
582
|
+
|
|
583
|
+
|
|
584
|
+
<a name="get_conversations_call"></a>
|
|
585
|
+
|
|
586
|
+
## -[**CallConversation**](CallConversation.html) get_conversations_call(call_id)
|
|
587
|
+
|
|
588
|
+
Get call conversation
|
|
589
|
+
|
|
590
|
+
|
|
591
|
+
|
|
592
|
+
Wraps GET /api/v2/conversations/calls/{callId}
|
|
593
|
+
|
|
594
|
+
|
|
595
|
+
### Example
|
|
596
|
+
~~~ruby
|
|
597
|
+
# load the gem
|
|
598
|
+
require 'purecloudplatformclientv2'
|
|
599
|
+
# setup authorization
|
|
600
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
601
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
602
|
+
environment = "mypurecloud.com"
|
|
603
|
+
|
|
604
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
605
|
+
|
|
606
|
+
PureCloud.configure do |config|
|
|
607
|
+
config.access_token = @authToken
|
|
608
|
+
end
|
|
609
|
+
|
|
610
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
611
|
+
|
|
612
|
+
call_id = "call_id_example" # String | callId
|
|
613
|
+
|
|
614
|
+
|
|
615
|
+
begin
|
|
616
|
+
#Get call conversation
|
|
617
|
+
result = api_instance.get_conversations_call(call_id)
|
|
618
|
+
p result
|
|
619
|
+
rescue PureCloud::ApiError => e
|
|
620
|
+
puts "Exception when calling ConversationsApi->get_conversations_call: #{e}"
|
|
621
|
+
end
|
|
622
|
+
~~~
|
|
623
|
+
|
|
624
|
+
### Parameters
|
|
625
|
+
|
|
626
|
+
Name | Type | Description | Notes
|
|
627
|
+
------------- | ------------- | ------------- | -------------
|
|
628
|
+
**call_id** | **String**| callId |
|
|
629
|
+
{: class="table table-striped"}
|
|
630
|
+
|
|
631
|
+
|
|
632
|
+
### Return type
|
|
633
|
+
|
|
634
|
+
[**CallConversation**](CallConversation.html)
|
|
635
|
+
|
|
636
|
+
### HTTP request headers
|
|
637
|
+
|
|
638
|
+
- **Content-Type**: application/json
|
|
639
|
+
- **Accept**: application/json
|
|
640
|
+
|
|
641
|
+
|
|
642
|
+
|
|
643
|
+
<a name="get_conversations_call_participant_wrapup"></a>
|
|
644
|
+
|
|
645
|
+
## -[**Wrapup**](Wrapup.html) get_conversations_call_participant_wrapup(call_id, participant_id, opts)
|
|
646
|
+
|
|
647
|
+
Get the wrap-up for this conversation participant.
|
|
648
|
+
|
|
649
|
+
|
|
650
|
+
|
|
651
|
+
Wraps GET /api/v2/conversations/calls/{callId}/participants/{participantId}/wrapup
|
|
652
|
+
|
|
653
|
+
|
|
654
|
+
### Example
|
|
655
|
+
~~~ruby
|
|
656
|
+
# load the gem
|
|
657
|
+
require 'purecloudplatformclientv2'
|
|
658
|
+
# setup authorization
|
|
659
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
660
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
661
|
+
environment = "mypurecloud.com"
|
|
662
|
+
|
|
663
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
664
|
+
|
|
665
|
+
PureCloud.configure do |config|
|
|
666
|
+
config.access_token = @authToken
|
|
667
|
+
end
|
|
668
|
+
|
|
669
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
670
|
+
|
|
671
|
+
call_id = "call_id_example" # String | callId
|
|
672
|
+
|
|
673
|
+
participant_id = "participant_id_example" # String | participantId
|
|
674
|
+
|
|
675
|
+
opts = {
|
|
676
|
+
provisional: false # BOOLEAN | Indicates if the wrap-up code is provisional.
|
|
677
|
+
}
|
|
678
|
+
|
|
679
|
+
begin
|
|
680
|
+
#Get the wrap-up for this conversation participant.
|
|
681
|
+
result = api_instance.get_conversations_call_participant_wrapup(call_id, participant_id, opts)
|
|
682
|
+
p result
|
|
683
|
+
rescue PureCloud::ApiError => e
|
|
684
|
+
puts "Exception when calling ConversationsApi->get_conversations_call_participant_wrapup: #{e}"
|
|
685
|
+
end
|
|
686
|
+
~~~
|
|
687
|
+
|
|
688
|
+
### Parameters
|
|
689
|
+
|
|
690
|
+
Name | Type | Description | Notes
|
|
691
|
+
------------- | ------------- | ------------- | -------------
|
|
692
|
+
**call_id** | **String**| callId |
|
|
693
|
+
**participant_id** | **String**| participantId |
|
|
694
|
+
**provisional** | **BOOLEAN**| Indicates if the wrap-up code is provisional. | [optional] [default to false]
|
|
695
|
+
{: class="table table-striped"}
|
|
696
|
+
|
|
697
|
+
|
|
698
|
+
### Return type
|
|
699
|
+
|
|
700
|
+
[**Wrapup**](Wrapup.html)
|
|
701
|
+
|
|
702
|
+
### HTTP request headers
|
|
703
|
+
|
|
704
|
+
- **Content-Type**: application/json
|
|
705
|
+
- **Accept**: application/json
|
|
706
|
+
|
|
707
|
+
|
|
708
|
+
|
|
709
|
+
<a name="get_conversations_call_participant_wrapupcodes"></a>
|
|
710
|
+
|
|
711
|
+
## -[**Array<WrapupCode>**](WrapupCode.html) get_conversations_call_participant_wrapupcodes(call_id, participant_id)
|
|
712
|
+
|
|
713
|
+
Get list of wrapup codes for this conversation participant
|
|
714
|
+
|
|
715
|
+
|
|
716
|
+
|
|
717
|
+
Wraps GET /api/v2/conversations/calls/{callId}/participants/{participantId}/wrapupcodes
|
|
718
|
+
|
|
719
|
+
|
|
720
|
+
### Example
|
|
721
|
+
~~~ruby
|
|
722
|
+
# load the gem
|
|
723
|
+
require 'purecloudplatformclientv2'
|
|
724
|
+
# setup authorization
|
|
725
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
726
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
727
|
+
environment = "mypurecloud.com"
|
|
728
|
+
|
|
729
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
730
|
+
|
|
731
|
+
PureCloud.configure do |config|
|
|
732
|
+
config.access_token = @authToken
|
|
733
|
+
end
|
|
734
|
+
|
|
735
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
736
|
+
|
|
737
|
+
call_id = "call_id_example" # String | callId
|
|
738
|
+
|
|
739
|
+
participant_id = "participant_id_example" # String | participantId
|
|
740
|
+
|
|
741
|
+
|
|
742
|
+
begin
|
|
743
|
+
#Get list of wrapup codes for this conversation participant
|
|
744
|
+
result = api_instance.get_conversations_call_participant_wrapupcodes(call_id, participant_id)
|
|
745
|
+
p result
|
|
746
|
+
rescue PureCloud::ApiError => e
|
|
747
|
+
puts "Exception when calling ConversationsApi->get_conversations_call_participant_wrapupcodes: #{e}"
|
|
748
|
+
end
|
|
749
|
+
~~~
|
|
750
|
+
|
|
751
|
+
### Parameters
|
|
752
|
+
|
|
753
|
+
Name | Type | Description | Notes
|
|
754
|
+
------------- | ------------- | ------------- | -------------
|
|
755
|
+
**call_id** | **String**| callId |
|
|
756
|
+
**participant_id** | **String**| participantId |
|
|
757
|
+
{: class="table table-striped"}
|
|
758
|
+
|
|
759
|
+
|
|
760
|
+
### Return type
|
|
761
|
+
|
|
762
|
+
[**Array<WrapupCode>**](WrapupCode.html)
|
|
763
|
+
|
|
764
|
+
### HTTP request headers
|
|
765
|
+
|
|
766
|
+
- **Content-Type**: application/json
|
|
767
|
+
- **Accept**: application/json
|
|
768
|
+
|
|
769
|
+
|
|
770
|
+
|
|
771
|
+
<a name="get_conversations_callback"></a>
|
|
772
|
+
|
|
773
|
+
## -[**CallbackConversation**](CallbackConversation.html) get_conversations_callback(callback_id)
|
|
774
|
+
|
|
775
|
+
Get callback conversation
|
|
776
|
+
|
|
777
|
+
|
|
778
|
+
|
|
779
|
+
Wraps GET /api/v2/conversations/callbacks/{callbackId}
|
|
780
|
+
|
|
781
|
+
|
|
782
|
+
### Example
|
|
783
|
+
~~~ruby
|
|
784
|
+
# load the gem
|
|
785
|
+
require 'purecloudplatformclientv2'
|
|
786
|
+
# setup authorization
|
|
787
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
788
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
789
|
+
environment = "mypurecloud.com"
|
|
790
|
+
|
|
791
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
792
|
+
|
|
793
|
+
PureCloud.configure do |config|
|
|
794
|
+
config.access_token = @authToken
|
|
795
|
+
end
|
|
796
|
+
|
|
797
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
798
|
+
|
|
799
|
+
callback_id = "callback_id_example" # String | callbackId
|
|
800
|
+
|
|
801
|
+
|
|
802
|
+
begin
|
|
803
|
+
#Get callback conversation
|
|
804
|
+
result = api_instance.get_conversations_callback(callback_id)
|
|
805
|
+
p result
|
|
806
|
+
rescue PureCloud::ApiError => e
|
|
807
|
+
puts "Exception when calling ConversationsApi->get_conversations_callback: #{e}"
|
|
808
|
+
end
|
|
809
|
+
~~~
|
|
810
|
+
|
|
811
|
+
### Parameters
|
|
812
|
+
|
|
813
|
+
Name | Type | Description | Notes
|
|
814
|
+
------------- | ------------- | ------------- | -------------
|
|
815
|
+
**callback_id** | **String**| callbackId |
|
|
816
|
+
{: class="table table-striped"}
|
|
817
|
+
|
|
818
|
+
|
|
819
|
+
### Return type
|
|
820
|
+
|
|
821
|
+
[**CallbackConversation**](CallbackConversation.html)
|
|
822
|
+
|
|
823
|
+
### HTTP request headers
|
|
824
|
+
|
|
825
|
+
- **Content-Type**: application/json
|
|
826
|
+
- **Accept**: application/json
|
|
827
|
+
|
|
828
|
+
|
|
829
|
+
|
|
830
|
+
<a name="get_conversations_callback_participant_wrapup"></a>
|
|
831
|
+
|
|
832
|
+
## -[**Wrapup**](Wrapup.html) get_conversations_callback_participant_wrapup(callback_id, participant_id, opts)
|
|
833
|
+
|
|
834
|
+
Get the wrap-up for this conversation participant.
|
|
835
|
+
|
|
836
|
+
|
|
837
|
+
|
|
838
|
+
Wraps GET /api/v2/conversations/callbacks/{callbackId}/participants/{participantId}/wrapup
|
|
839
|
+
|
|
840
|
+
|
|
841
|
+
### Example
|
|
842
|
+
~~~ruby
|
|
843
|
+
# load the gem
|
|
844
|
+
require 'purecloudplatformclientv2'
|
|
845
|
+
# setup authorization
|
|
846
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
847
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
848
|
+
environment = "mypurecloud.com"
|
|
849
|
+
|
|
850
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
851
|
+
|
|
852
|
+
PureCloud.configure do |config|
|
|
853
|
+
config.access_token = @authToken
|
|
854
|
+
end
|
|
855
|
+
|
|
856
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
857
|
+
|
|
858
|
+
callback_id = "callback_id_example" # String | callbackId
|
|
859
|
+
|
|
860
|
+
participant_id = "participant_id_example" # String | participantId
|
|
861
|
+
|
|
862
|
+
opts = {
|
|
863
|
+
provisional: false # BOOLEAN | Indicates if the wrap-up code is provisional.
|
|
864
|
+
}
|
|
865
|
+
|
|
866
|
+
begin
|
|
867
|
+
#Get the wrap-up for this conversation participant.
|
|
868
|
+
result = api_instance.get_conversations_callback_participant_wrapup(callback_id, participant_id, opts)
|
|
869
|
+
p result
|
|
870
|
+
rescue PureCloud::ApiError => e
|
|
871
|
+
puts "Exception when calling ConversationsApi->get_conversations_callback_participant_wrapup: #{e}"
|
|
872
|
+
end
|
|
873
|
+
~~~
|
|
874
|
+
|
|
875
|
+
### Parameters
|
|
876
|
+
|
|
877
|
+
Name | Type | Description | Notes
|
|
878
|
+
------------- | ------------- | ------------- | -------------
|
|
879
|
+
**callback_id** | **String**| callbackId |
|
|
880
|
+
**participant_id** | **String**| participantId |
|
|
881
|
+
**provisional** | **BOOLEAN**| Indicates if the wrap-up code is provisional. | [optional] [default to false]
|
|
882
|
+
{: class="table table-striped"}
|
|
883
|
+
|
|
884
|
+
|
|
885
|
+
### Return type
|
|
886
|
+
|
|
887
|
+
[**Wrapup**](Wrapup.html)
|
|
888
|
+
|
|
889
|
+
### HTTP request headers
|
|
890
|
+
|
|
891
|
+
- **Content-Type**: application/json
|
|
892
|
+
- **Accept**: application/json
|
|
893
|
+
|
|
894
|
+
|
|
895
|
+
|
|
896
|
+
<a name="get_conversations_callback_participant_wrapupcodes"></a>
|
|
897
|
+
|
|
898
|
+
## -[**Array<WrapupCode>**](WrapupCode.html) get_conversations_callback_participant_wrapupcodes(callback_id, participant_id)
|
|
899
|
+
|
|
900
|
+
Get list of wrapup codes for this conversation participant
|
|
901
|
+
|
|
902
|
+
|
|
903
|
+
|
|
904
|
+
Wraps GET /api/v2/conversations/callbacks/{callbackId}/participants/{participantId}/wrapupcodes
|
|
905
|
+
|
|
906
|
+
|
|
907
|
+
### Example
|
|
908
|
+
~~~ruby
|
|
909
|
+
# load the gem
|
|
910
|
+
require 'purecloudplatformclientv2'
|
|
911
|
+
# setup authorization
|
|
912
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
913
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
914
|
+
environment = "mypurecloud.com"
|
|
915
|
+
|
|
916
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
917
|
+
|
|
918
|
+
PureCloud.configure do |config|
|
|
919
|
+
config.access_token = @authToken
|
|
920
|
+
end
|
|
921
|
+
|
|
922
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
923
|
+
|
|
924
|
+
callback_id = "callback_id_example" # String | callbackId
|
|
925
|
+
|
|
926
|
+
participant_id = "participant_id_example" # String | participantId
|
|
927
|
+
|
|
928
|
+
|
|
929
|
+
begin
|
|
930
|
+
#Get list of wrapup codes for this conversation participant
|
|
931
|
+
result = api_instance.get_conversations_callback_participant_wrapupcodes(callback_id, participant_id)
|
|
932
|
+
p result
|
|
933
|
+
rescue PureCloud::ApiError => e
|
|
934
|
+
puts "Exception when calling ConversationsApi->get_conversations_callback_participant_wrapupcodes: #{e}"
|
|
935
|
+
end
|
|
936
|
+
~~~
|
|
937
|
+
|
|
938
|
+
### Parameters
|
|
939
|
+
|
|
940
|
+
Name | Type | Description | Notes
|
|
941
|
+
------------- | ------------- | ------------- | -------------
|
|
942
|
+
**callback_id** | **String**| callbackId |
|
|
943
|
+
**participant_id** | **String**| participantId |
|
|
944
|
+
{: class="table table-striped"}
|
|
945
|
+
|
|
946
|
+
|
|
947
|
+
### Return type
|
|
948
|
+
|
|
949
|
+
[**Array<WrapupCode>**](WrapupCode.html)
|
|
950
|
+
|
|
951
|
+
### HTTP request headers
|
|
952
|
+
|
|
953
|
+
- **Content-Type**: application/json
|
|
954
|
+
- **Accept**: application/json
|
|
955
|
+
|
|
956
|
+
|
|
957
|
+
|
|
958
|
+
<a name="get_conversations_callbacks"></a>
|
|
959
|
+
|
|
960
|
+
## -[**CallbackConversationEntityListing**](CallbackConversationEntityListing.html) get_conversations_callbacks
|
|
961
|
+
|
|
962
|
+
Get callback conversations
|
|
963
|
+
|
|
964
|
+
|
|
965
|
+
|
|
966
|
+
Wraps GET /api/v2/conversations/callbacks
|
|
967
|
+
|
|
968
|
+
|
|
969
|
+
### Example
|
|
970
|
+
~~~ruby
|
|
971
|
+
# load the gem
|
|
972
|
+
require 'purecloudplatformclientv2'
|
|
973
|
+
# setup authorization
|
|
974
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
975
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
976
|
+
environment = "mypurecloud.com"
|
|
977
|
+
|
|
978
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
979
|
+
|
|
980
|
+
PureCloud.configure do |config|
|
|
981
|
+
config.access_token = @authToken
|
|
982
|
+
end
|
|
983
|
+
|
|
984
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
985
|
+
|
|
986
|
+
begin
|
|
987
|
+
#Get callback conversations
|
|
988
|
+
result = api_instance.get_conversations_callbacks
|
|
989
|
+
p result
|
|
990
|
+
rescue PureCloud::ApiError => e
|
|
991
|
+
puts "Exception when calling ConversationsApi->get_conversations_callbacks: #{e}"
|
|
992
|
+
end
|
|
993
|
+
~~~
|
|
994
|
+
|
|
995
|
+
### Parameters
|
|
996
|
+
This endpoint does not need any parameter.
|
|
997
|
+
{: class="table table-striped"}
|
|
998
|
+
|
|
999
|
+
|
|
1000
|
+
### Return type
|
|
1001
|
+
|
|
1002
|
+
[**CallbackConversationEntityListing**](CallbackConversationEntityListing.html)
|
|
1003
|
+
|
|
1004
|
+
### HTTP request headers
|
|
1005
|
+
|
|
1006
|
+
- **Content-Type**: application/json
|
|
1007
|
+
- **Accept**: application/json
|
|
1008
|
+
|
|
1009
|
+
|
|
1010
|
+
|
|
1011
|
+
<a name="get_conversations_calls"></a>
|
|
1012
|
+
|
|
1013
|
+
## -[**CallConversationEntityListing**](CallConversationEntityListing.html) get_conversations_calls
|
|
1014
|
+
|
|
1015
|
+
Get recent conversations
|
|
1016
|
+
|
|
1017
|
+
|
|
1018
|
+
|
|
1019
|
+
Wraps GET /api/v2/conversations/calls
|
|
1020
|
+
|
|
1021
|
+
|
|
1022
|
+
### Example
|
|
1023
|
+
~~~ruby
|
|
1024
|
+
# load the gem
|
|
1025
|
+
require 'purecloudplatformclientv2'
|
|
1026
|
+
# setup authorization
|
|
1027
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1028
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1029
|
+
environment = "mypurecloud.com"
|
|
1030
|
+
|
|
1031
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1032
|
+
|
|
1033
|
+
PureCloud.configure do |config|
|
|
1034
|
+
config.access_token = @authToken
|
|
1035
|
+
end
|
|
1036
|
+
|
|
1037
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
1038
|
+
|
|
1039
|
+
begin
|
|
1040
|
+
#Get recent conversations
|
|
1041
|
+
result = api_instance.get_conversations_calls
|
|
1042
|
+
p result
|
|
1043
|
+
rescue PureCloud::ApiError => e
|
|
1044
|
+
puts "Exception when calling ConversationsApi->get_conversations_calls: #{e}"
|
|
1045
|
+
end
|
|
1046
|
+
~~~
|
|
1047
|
+
|
|
1048
|
+
### Parameters
|
|
1049
|
+
This endpoint does not need any parameter.
|
|
1050
|
+
{: class="table table-striped"}
|
|
1051
|
+
|
|
1052
|
+
|
|
1053
|
+
### Return type
|
|
1054
|
+
|
|
1055
|
+
[**CallConversationEntityListing**](CallConversationEntityListing.html)
|
|
1056
|
+
|
|
1057
|
+
### HTTP request headers
|
|
1058
|
+
|
|
1059
|
+
- **Content-Type**: application/json
|
|
1060
|
+
- **Accept**: application/json
|
|
1061
|
+
|
|
1062
|
+
|
|
1063
|
+
|
|
1064
|
+
<a name="get_conversations_calls_history"></a>
|
|
1065
|
+
|
|
1066
|
+
## -[**CallConversationEntityListing**](CallConversationEntityListing.html) get_conversations_calls_history(opts)
|
|
1067
|
+
|
|
1068
|
+
Get call history
|
|
1069
|
+
|
|
1070
|
+
|
|
1071
|
+
|
|
1072
|
+
Wraps GET /api/v2/conversations/calls/history
|
|
1073
|
+
|
|
1074
|
+
|
|
1075
|
+
### Example
|
|
1076
|
+
~~~ruby
|
|
1077
|
+
# load the gem
|
|
1078
|
+
require 'purecloudplatformclientv2'
|
|
1079
|
+
# setup authorization
|
|
1080
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1081
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1082
|
+
environment = "mypurecloud.com"
|
|
1083
|
+
|
|
1084
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1085
|
+
|
|
1086
|
+
PureCloud.configure do |config|
|
|
1087
|
+
config.access_token = @authToken
|
|
1088
|
+
end
|
|
1089
|
+
|
|
1090
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
1091
|
+
|
|
1092
|
+
opts = {
|
|
1093
|
+
page_size: 25, # Integer | Page size
|
|
1094
|
+
page_number: 1, # Integer | Page number
|
|
1095
|
+
interval: "interval_example" # String | Interval string; format is ISO-8601. Separate start and end times with forward slash '/'
|
|
1096
|
+
}
|
|
1097
|
+
|
|
1098
|
+
begin
|
|
1099
|
+
#Get call history
|
|
1100
|
+
result = api_instance.get_conversations_calls_history(opts)
|
|
1101
|
+
p result
|
|
1102
|
+
rescue PureCloud::ApiError => e
|
|
1103
|
+
puts "Exception when calling ConversationsApi->get_conversations_calls_history: #{e}"
|
|
1104
|
+
end
|
|
1105
|
+
~~~
|
|
1106
|
+
|
|
1107
|
+
### Parameters
|
|
1108
|
+
|
|
1109
|
+
Name | Type | Description | Notes
|
|
1110
|
+
------------- | ------------- | ------------- | -------------
|
|
1111
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25]
|
|
1112
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1]
|
|
1113
|
+
**interval** | **String**| Interval string; format is ISO-8601. Separate start and end times with forward slash '/' | [optional]
|
|
1114
|
+
{: class="table table-striped"}
|
|
1115
|
+
|
|
1116
|
+
|
|
1117
|
+
### Return type
|
|
1118
|
+
|
|
1119
|
+
[**CallConversationEntityListing**](CallConversationEntityListing.html)
|
|
1120
|
+
|
|
1121
|
+
### HTTP request headers
|
|
1122
|
+
|
|
1123
|
+
- **Content-Type**: application/json
|
|
1124
|
+
- **Accept**: application/json
|
|
1125
|
+
|
|
1126
|
+
|
|
1127
|
+
|
|
1128
|
+
<a name="get_conversations_calls_maximumconferenceparties"></a>
|
|
1129
|
+
|
|
1130
|
+
## -[**MaxParticipants**](MaxParticipants.html) get_conversations_calls_maximumconferenceparties
|
|
1131
|
+
|
|
1132
|
+
Get the maximum number of participants that this user can have on a conference
|
|
1133
|
+
|
|
1134
|
+
|
|
1135
|
+
|
|
1136
|
+
Wraps GET /api/v2/conversations/calls/maximumconferenceparties
|
|
1137
|
+
|
|
1138
|
+
|
|
1139
|
+
### Example
|
|
1140
|
+
~~~ruby
|
|
1141
|
+
# load the gem
|
|
1142
|
+
require 'purecloudplatformclientv2'
|
|
1143
|
+
# setup authorization
|
|
1144
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1145
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1146
|
+
environment = "mypurecloud.com"
|
|
1147
|
+
|
|
1148
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1149
|
+
|
|
1150
|
+
PureCloud.configure do |config|
|
|
1151
|
+
config.access_token = @authToken
|
|
1152
|
+
end
|
|
1153
|
+
|
|
1154
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
1155
|
+
|
|
1156
|
+
begin
|
|
1157
|
+
#Get the maximum number of participants that this user can have on a conference
|
|
1158
|
+
result = api_instance.get_conversations_calls_maximumconferenceparties
|
|
1159
|
+
p result
|
|
1160
|
+
rescue PureCloud::ApiError => e
|
|
1161
|
+
puts "Exception when calling ConversationsApi->get_conversations_calls_maximumconferenceparties: #{e}"
|
|
1162
|
+
end
|
|
1163
|
+
~~~
|
|
1164
|
+
|
|
1165
|
+
### Parameters
|
|
1166
|
+
This endpoint does not need any parameter.
|
|
1167
|
+
{: class="table table-striped"}
|
|
1168
|
+
|
|
1169
|
+
|
|
1170
|
+
### Return type
|
|
1171
|
+
|
|
1172
|
+
[**MaxParticipants**](MaxParticipants.html)
|
|
1173
|
+
|
|
1174
|
+
### HTTP request headers
|
|
1175
|
+
|
|
1176
|
+
- **Content-Type**: application/json
|
|
1177
|
+
- **Accept**: application/json
|
|
1178
|
+
|
|
1179
|
+
|
|
1180
|
+
|
|
1181
|
+
<a name="get_conversations_chat"></a>
|
|
1182
|
+
|
|
1183
|
+
## -[**ChatConversation**](ChatConversation.html) get_conversations_chat(chat_id)
|
|
1184
|
+
|
|
1185
|
+
Get chat conversation
|
|
1186
|
+
|
|
1187
|
+
|
|
1188
|
+
|
|
1189
|
+
Wraps GET /api/v2/conversations/chats/{chatId}
|
|
1190
|
+
|
|
1191
|
+
|
|
1192
|
+
### Example
|
|
1193
|
+
~~~ruby
|
|
1194
|
+
# load the gem
|
|
1195
|
+
require 'purecloudplatformclientv2'
|
|
1196
|
+
# setup authorization
|
|
1197
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1198
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1199
|
+
environment = "mypurecloud.com"
|
|
1200
|
+
|
|
1201
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1202
|
+
|
|
1203
|
+
PureCloud.configure do |config|
|
|
1204
|
+
config.access_token = @authToken
|
|
1205
|
+
end
|
|
1206
|
+
|
|
1207
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
1208
|
+
|
|
1209
|
+
chat_id = "chat_id_example" # String | chatId
|
|
1210
|
+
|
|
1211
|
+
|
|
1212
|
+
begin
|
|
1213
|
+
#Get chat conversation
|
|
1214
|
+
result = api_instance.get_conversations_chat(chat_id)
|
|
1215
|
+
p result
|
|
1216
|
+
rescue PureCloud::ApiError => e
|
|
1217
|
+
puts "Exception when calling ConversationsApi->get_conversations_chat: #{e}"
|
|
1218
|
+
end
|
|
1219
|
+
~~~
|
|
1220
|
+
|
|
1221
|
+
### Parameters
|
|
1222
|
+
|
|
1223
|
+
Name | Type | Description | Notes
|
|
1224
|
+
------------- | ------------- | ------------- | -------------
|
|
1225
|
+
**chat_id** | **String**| chatId |
|
|
1226
|
+
{: class="table table-striped"}
|
|
1227
|
+
|
|
1228
|
+
|
|
1229
|
+
### Return type
|
|
1230
|
+
|
|
1231
|
+
[**ChatConversation**](ChatConversation.html)
|
|
1232
|
+
|
|
1233
|
+
### HTTP request headers
|
|
1234
|
+
|
|
1235
|
+
- **Content-Type**: application/json
|
|
1236
|
+
- **Accept**: application/json
|
|
1237
|
+
|
|
1238
|
+
|
|
1239
|
+
|
|
1240
|
+
<a name="get_conversations_chat_participant_wrapup"></a>
|
|
1241
|
+
|
|
1242
|
+
## -[**Wrapup**](Wrapup.html) get_conversations_chat_participant_wrapup(chat_id, participant_id, opts)
|
|
1243
|
+
|
|
1244
|
+
Get the wrap-up for this conversation participant.
|
|
1245
|
+
|
|
1246
|
+
|
|
1247
|
+
|
|
1248
|
+
Wraps GET /api/v2/conversations/chats/{chatId}/participants/{participantId}/wrapup
|
|
1249
|
+
|
|
1250
|
+
|
|
1251
|
+
### Example
|
|
1252
|
+
~~~ruby
|
|
1253
|
+
# load the gem
|
|
1254
|
+
require 'purecloudplatformclientv2'
|
|
1255
|
+
# setup authorization
|
|
1256
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1257
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1258
|
+
environment = "mypurecloud.com"
|
|
1259
|
+
|
|
1260
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1261
|
+
|
|
1262
|
+
PureCloud.configure do |config|
|
|
1263
|
+
config.access_token = @authToken
|
|
1264
|
+
end
|
|
1265
|
+
|
|
1266
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
1267
|
+
|
|
1268
|
+
chat_id = "chat_id_example" # String | chatId
|
|
1269
|
+
|
|
1270
|
+
participant_id = "participant_id_example" # String | participantId
|
|
1271
|
+
|
|
1272
|
+
opts = {
|
|
1273
|
+
provisional: false # BOOLEAN | Indicates if the wrap-up code is provisional.
|
|
1274
|
+
}
|
|
1275
|
+
|
|
1276
|
+
begin
|
|
1277
|
+
#Get the wrap-up for this conversation participant.
|
|
1278
|
+
result = api_instance.get_conversations_chat_participant_wrapup(chat_id, participant_id, opts)
|
|
1279
|
+
p result
|
|
1280
|
+
rescue PureCloud::ApiError => e
|
|
1281
|
+
puts "Exception when calling ConversationsApi->get_conversations_chat_participant_wrapup: #{e}"
|
|
1282
|
+
end
|
|
1283
|
+
~~~
|
|
1284
|
+
|
|
1285
|
+
### Parameters
|
|
1286
|
+
|
|
1287
|
+
Name | Type | Description | Notes
|
|
1288
|
+
------------- | ------------- | ------------- | -------------
|
|
1289
|
+
**chat_id** | **String**| chatId |
|
|
1290
|
+
**participant_id** | **String**| participantId |
|
|
1291
|
+
**provisional** | **BOOLEAN**| Indicates if the wrap-up code is provisional. | [optional] [default to false]
|
|
1292
|
+
{: class="table table-striped"}
|
|
1293
|
+
|
|
1294
|
+
|
|
1295
|
+
### Return type
|
|
1296
|
+
|
|
1297
|
+
[**Wrapup**](Wrapup.html)
|
|
1298
|
+
|
|
1299
|
+
### HTTP request headers
|
|
1300
|
+
|
|
1301
|
+
- **Content-Type**: application/json
|
|
1302
|
+
- **Accept**: application/json
|
|
1303
|
+
|
|
1304
|
+
|
|
1305
|
+
|
|
1306
|
+
<a name="get_conversations_chat_participant_wrapupcodes"></a>
|
|
1307
|
+
|
|
1308
|
+
## -[**Array<WrapupCode>**](WrapupCode.html) get_conversations_chat_participant_wrapupcodes(chat_id, participant_id)
|
|
1309
|
+
|
|
1310
|
+
Get list of wrapup codes for this conversation participant
|
|
1311
|
+
|
|
1312
|
+
|
|
1313
|
+
|
|
1314
|
+
Wraps GET /api/v2/conversations/chats/{chatId}/participants/{participantId}/wrapupcodes
|
|
1315
|
+
|
|
1316
|
+
|
|
1317
|
+
### Example
|
|
1318
|
+
~~~ruby
|
|
1319
|
+
# load the gem
|
|
1320
|
+
require 'purecloudplatformclientv2'
|
|
1321
|
+
# setup authorization
|
|
1322
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1323
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1324
|
+
environment = "mypurecloud.com"
|
|
1325
|
+
|
|
1326
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1327
|
+
|
|
1328
|
+
PureCloud.configure do |config|
|
|
1329
|
+
config.access_token = @authToken
|
|
1330
|
+
end
|
|
1331
|
+
|
|
1332
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
1333
|
+
|
|
1334
|
+
chat_id = "chat_id_example" # String | chatId
|
|
1335
|
+
|
|
1336
|
+
participant_id = "participant_id_example" # String | participantId
|
|
1337
|
+
|
|
1338
|
+
|
|
1339
|
+
begin
|
|
1340
|
+
#Get list of wrapup codes for this conversation participant
|
|
1341
|
+
result = api_instance.get_conversations_chat_participant_wrapupcodes(chat_id, participant_id)
|
|
1342
|
+
p result
|
|
1343
|
+
rescue PureCloud::ApiError => e
|
|
1344
|
+
puts "Exception when calling ConversationsApi->get_conversations_chat_participant_wrapupcodes: #{e}"
|
|
1345
|
+
end
|
|
1346
|
+
~~~
|
|
1347
|
+
|
|
1348
|
+
### Parameters
|
|
1349
|
+
|
|
1350
|
+
Name | Type | Description | Notes
|
|
1351
|
+
------------- | ------------- | ------------- | -------------
|
|
1352
|
+
**chat_id** | **String**| chatId |
|
|
1353
|
+
**participant_id** | **String**| participantId |
|
|
1354
|
+
{: class="table table-striped"}
|
|
1355
|
+
|
|
1356
|
+
|
|
1357
|
+
### Return type
|
|
1358
|
+
|
|
1359
|
+
[**Array<WrapupCode>**](WrapupCode.html)
|
|
1360
|
+
|
|
1361
|
+
### HTTP request headers
|
|
1362
|
+
|
|
1363
|
+
- **Content-Type**: application/json
|
|
1364
|
+
- **Accept**: application/json
|
|
1365
|
+
|
|
1366
|
+
|
|
1367
|
+
|
|
1368
|
+
<a name="get_conversations_chats"></a>
|
|
1369
|
+
|
|
1370
|
+
## -[**ChatConversationEntityListing**](ChatConversationEntityListing.html) get_conversations_chats
|
|
1371
|
+
|
|
1372
|
+
Get recent chat conversations
|
|
1373
|
+
|
|
1374
|
+
|
|
1375
|
+
|
|
1376
|
+
Wraps GET /api/v2/conversations/chats
|
|
1377
|
+
|
|
1378
|
+
|
|
1379
|
+
### Example
|
|
1380
|
+
~~~ruby
|
|
1381
|
+
# load the gem
|
|
1382
|
+
require 'purecloudplatformclientv2'
|
|
1383
|
+
# setup authorization
|
|
1384
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1385
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1386
|
+
environment = "mypurecloud.com"
|
|
1387
|
+
|
|
1388
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1389
|
+
|
|
1390
|
+
PureCloud.configure do |config|
|
|
1391
|
+
config.access_token = @authToken
|
|
1392
|
+
end
|
|
1393
|
+
|
|
1394
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
1395
|
+
|
|
1396
|
+
begin
|
|
1397
|
+
#Get recent chat conversations
|
|
1398
|
+
result = api_instance.get_conversations_chats
|
|
1399
|
+
p result
|
|
1400
|
+
rescue PureCloud::ApiError => e
|
|
1401
|
+
puts "Exception when calling ConversationsApi->get_conversations_chats: #{e}"
|
|
1402
|
+
end
|
|
1403
|
+
~~~
|
|
1404
|
+
|
|
1405
|
+
### Parameters
|
|
1406
|
+
This endpoint does not need any parameter.
|
|
1407
|
+
{: class="table table-striped"}
|
|
1408
|
+
|
|
1409
|
+
|
|
1410
|
+
### Return type
|
|
1411
|
+
|
|
1412
|
+
[**ChatConversationEntityListing**](ChatConversationEntityListing.html)
|
|
1413
|
+
|
|
1414
|
+
### HTTP request headers
|
|
1415
|
+
|
|
1416
|
+
- **Content-Type**: application/json
|
|
1417
|
+
- **Accept**: application/json
|
|
1418
|
+
|
|
1419
|
+
|
|
1420
|
+
|
|
1421
|
+
<a name="get_conversations_cobrowsesession"></a>
|
|
1422
|
+
|
|
1423
|
+
## -[**CobrowseConversation**](CobrowseConversation.html) get_conversations_cobrowsesession(cobrowse_id)
|
|
1424
|
+
|
|
1425
|
+
Get cobrowse conversation
|
|
1426
|
+
|
|
1427
|
+
|
|
1428
|
+
|
|
1429
|
+
Wraps GET /api/v2/conversations/cobrowsesessions/{cobrowseId}
|
|
1430
|
+
|
|
1431
|
+
|
|
1432
|
+
### Example
|
|
1433
|
+
~~~ruby
|
|
1434
|
+
# load the gem
|
|
1435
|
+
require 'purecloudplatformclientv2'
|
|
1436
|
+
# setup authorization
|
|
1437
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1438
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1439
|
+
environment = "mypurecloud.com"
|
|
1440
|
+
|
|
1441
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1442
|
+
|
|
1443
|
+
PureCloud.configure do |config|
|
|
1444
|
+
config.access_token = @authToken
|
|
1445
|
+
end
|
|
1446
|
+
|
|
1447
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
1448
|
+
|
|
1449
|
+
cobrowse_id = "cobrowse_id_example" # String | cobrowseId
|
|
1450
|
+
|
|
1451
|
+
|
|
1452
|
+
begin
|
|
1453
|
+
#Get cobrowse conversation
|
|
1454
|
+
result = api_instance.get_conversations_cobrowsesession(cobrowse_id)
|
|
1455
|
+
p result
|
|
1456
|
+
rescue PureCloud::ApiError => e
|
|
1457
|
+
puts "Exception when calling ConversationsApi->get_conversations_cobrowsesession: #{e}"
|
|
1458
|
+
end
|
|
1459
|
+
~~~
|
|
1460
|
+
|
|
1461
|
+
### Parameters
|
|
1462
|
+
|
|
1463
|
+
Name | Type | Description | Notes
|
|
1464
|
+
------------- | ------------- | ------------- | -------------
|
|
1465
|
+
**cobrowse_id** | **String**| cobrowseId |
|
|
1466
|
+
{: class="table table-striped"}
|
|
1467
|
+
|
|
1468
|
+
|
|
1469
|
+
### Return type
|
|
1470
|
+
|
|
1471
|
+
[**CobrowseConversation**](CobrowseConversation.html)
|
|
1472
|
+
|
|
1473
|
+
### HTTP request headers
|
|
1474
|
+
|
|
1475
|
+
- **Content-Type**: application/json
|
|
1476
|
+
- **Accept**: application/json
|
|
1477
|
+
|
|
1478
|
+
|
|
1479
|
+
|
|
1480
|
+
<a name="get_conversations_cobrowsesession_participant_wrapup"></a>
|
|
1481
|
+
|
|
1482
|
+
## -[**Wrapup**](Wrapup.html) get_conversations_cobrowsesession_participant_wrapup(cobrowse_id, participant_id, opts)
|
|
1483
|
+
|
|
1484
|
+
Get the wrap-up for this conversation participant.
|
|
1485
|
+
|
|
1486
|
+
|
|
1487
|
+
|
|
1488
|
+
Wraps GET /api/v2/conversations/cobrowsesessions/{cobrowseId}/participants/{participantId}/wrapup
|
|
1489
|
+
|
|
1490
|
+
|
|
1491
|
+
### Example
|
|
1492
|
+
~~~ruby
|
|
1493
|
+
# load the gem
|
|
1494
|
+
require 'purecloudplatformclientv2'
|
|
1495
|
+
# setup authorization
|
|
1496
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1497
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1498
|
+
environment = "mypurecloud.com"
|
|
1499
|
+
|
|
1500
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1501
|
+
|
|
1502
|
+
PureCloud.configure do |config|
|
|
1503
|
+
config.access_token = @authToken
|
|
1504
|
+
end
|
|
1505
|
+
|
|
1506
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
1507
|
+
|
|
1508
|
+
cobrowse_id = "cobrowse_id_example" # String | cobrowseId
|
|
1509
|
+
|
|
1510
|
+
participant_id = "participant_id_example" # String | participantId
|
|
1511
|
+
|
|
1512
|
+
opts = {
|
|
1513
|
+
provisional: false # BOOLEAN | Indicates if the wrap-up code is provisional.
|
|
1514
|
+
}
|
|
1515
|
+
|
|
1516
|
+
begin
|
|
1517
|
+
#Get the wrap-up for this conversation participant.
|
|
1518
|
+
result = api_instance.get_conversations_cobrowsesession_participant_wrapup(cobrowse_id, participant_id, opts)
|
|
1519
|
+
p result
|
|
1520
|
+
rescue PureCloud::ApiError => e
|
|
1521
|
+
puts "Exception when calling ConversationsApi->get_conversations_cobrowsesession_participant_wrapup: #{e}"
|
|
1522
|
+
end
|
|
1523
|
+
~~~
|
|
1524
|
+
|
|
1525
|
+
### Parameters
|
|
1526
|
+
|
|
1527
|
+
Name | Type | Description | Notes
|
|
1528
|
+
------------- | ------------- | ------------- | -------------
|
|
1529
|
+
**cobrowse_id** | **String**| cobrowseId |
|
|
1530
|
+
**participant_id** | **String**| participantId |
|
|
1531
|
+
**provisional** | **BOOLEAN**| Indicates if the wrap-up code is provisional. | [optional] [default to false]
|
|
1532
|
+
{: class="table table-striped"}
|
|
1533
|
+
|
|
1534
|
+
|
|
1535
|
+
### Return type
|
|
1536
|
+
|
|
1537
|
+
[**Wrapup**](Wrapup.html)
|
|
1538
|
+
|
|
1539
|
+
### HTTP request headers
|
|
1540
|
+
|
|
1541
|
+
- **Content-Type**: application/json
|
|
1542
|
+
- **Accept**: application/json
|
|
1543
|
+
|
|
1544
|
+
|
|
1545
|
+
|
|
1546
|
+
<a name="get_conversations_cobrowsesession_participant_wrapupcodes"></a>
|
|
1547
|
+
|
|
1548
|
+
## -[**Array<WrapupCode>**](WrapupCode.html) get_conversations_cobrowsesession_participant_wrapupcodes(cobrowse_id, participant_id)
|
|
1549
|
+
|
|
1550
|
+
Get list of wrapup codes for this conversation participant
|
|
1551
|
+
|
|
1552
|
+
|
|
1553
|
+
|
|
1554
|
+
Wraps GET /api/v2/conversations/cobrowsesessions/{cobrowseId}/participants/{participantId}/wrapupcodes
|
|
1555
|
+
|
|
1556
|
+
|
|
1557
|
+
### Example
|
|
1558
|
+
~~~ruby
|
|
1559
|
+
# load the gem
|
|
1560
|
+
require 'purecloudplatformclientv2'
|
|
1561
|
+
# setup authorization
|
|
1562
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1563
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1564
|
+
environment = "mypurecloud.com"
|
|
1565
|
+
|
|
1566
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1567
|
+
|
|
1568
|
+
PureCloud.configure do |config|
|
|
1569
|
+
config.access_token = @authToken
|
|
1570
|
+
end
|
|
1571
|
+
|
|
1572
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
1573
|
+
|
|
1574
|
+
cobrowse_id = "cobrowse_id_example" # String | cobrowseId
|
|
1575
|
+
|
|
1576
|
+
participant_id = "participant_id_example" # String | participantId
|
|
1577
|
+
|
|
1578
|
+
|
|
1579
|
+
begin
|
|
1580
|
+
#Get list of wrapup codes for this conversation participant
|
|
1581
|
+
result = api_instance.get_conversations_cobrowsesession_participant_wrapupcodes(cobrowse_id, participant_id)
|
|
1582
|
+
p result
|
|
1583
|
+
rescue PureCloud::ApiError => e
|
|
1584
|
+
puts "Exception when calling ConversationsApi->get_conversations_cobrowsesession_participant_wrapupcodes: #{e}"
|
|
1585
|
+
end
|
|
1586
|
+
~~~
|
|
1587
|
+
|
|
1588
|
+
### Parameters
|
|
1589
|
+
|
|
1590
|
+
Name | Type | Description | Notes
|
|
1591
|
+
------------- | ------------- | ------------- | -------------
|
|
1592
|
+
**cobrowse_id** | **String**| cobrowseId |
|
|
1593
|
+
**participant_id** | **String**| participantId |
|
|
1594
|
+
{: class="table table-striped"}
|
|
1595
|
+
|
|
1596
|
+
|
|
1597
|
+
### Return type
|
|
1598
|
+
|
|
1599
|
+
[**Array<WrapupCode>**](WrapupCode.html)
|
|
1600
|
+
|
|
1601
|
+
### HTTP request headers
|
|
1602
|
+
|
|
1603
|
+
- **Content-Type**: application/json
|
|
1604
|
+
- **Accept**: application/json
|
|
1605
|
+
|
|
1606
|
+
|
|
1607
|
+
|
|
1608
|
+
<a name="get_conversations_cobrowsesessions"></a>
|
|
1609
|
+
|
|
1610
|
+
## -[**CobrowseConversationEntityListing**](CobrowseConversationEntityListing.html) get_conversations_cobrowsesessions
|
|
1611
|
+
|
|
1612
|
+
Get recent cobrowse conversations
|
|
1613
|
+
|
|
1614
|
+
|
|
1615
|
+
|
|
1616
|
+
Wraps GET /api/v2/conversations/cobrowsesessions
|
|
1617
|
+
|
|
1618
|
+
|
|
1619
|
+
### Example
|
|
1620
|
+
~~~ruby
|
|
1621
|
+
# load the gem
|
|
1622
|
+
require 'purecloudplatformclientv2'
|
|
1623
|
+
# setup authorization
|
|
1624
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1625
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1626
|
+
environment = "mypurecloud.com"
|
|
1627
|
+
|
|
1628
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1629
|
+
|
|
1630
|
+
PureCloud.configure do |config|
|
|
1631
|
+
config.access_token = @authToken
|
|
1632
|
+
end
|
|
1633
|
+
|
|
1634
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
1635
|
+
|
|
1636
|
+
begin
|
|
1637
|
+
#Get recent cobrowse conversations
|
|
1638
|
+
result = api_instance.get_conversations_cobrowsesessions
|
|
1639
|
+
p result
|
|
1640
|
+
rescue PureCloud::ApiError => e
|
|
1641
|
+
puts "Exception when calling ConversationsApi->get_conversations_cobrowsesessions: #{e}"
|
|
1642
|
+
end
|
|
1643
|
+
~~~
|
|
1644
|
+
|
|
1645
|
+
### Parameters
|
|
1646
|
+
This endpoint does not need any parameter.
|
|
1647
|
+
{: class="table table-striped"}
|
|
1648
|
+
|
|
1649
|
+
|
|
1650
|
+
### Return type
|
|
1651
|
+
|
|
1652
|
+
[**CobrowseConversationEntityListing**](CobrowseConversationEntityListing.html)
|
|
1653
|
+
|
|
1654
|
+
### HTTP request headers
|
|
1655
|
+
|
|
1656
|
+
- **Content-Type**: application/json
|
|
1657
|
+
- **Accept**: application/json
|
|
1658
|
+
|
|
1659
|
+
|
|
1660
|
+
|
|
1661
|
+
<a name="get_conversations_email"></a>
|
|
1662
|
+
|
|
1663
|
+
## -[**EmailConversation**](EmailConversation.html) get_conversations_email(email_id)
|
|
1664
|
+
|
|
1665
|
+
Get email conversation
|
|
1666
|
+
|
|
1667
|
+
|
|
1668
|
+
|
|
1669
|
+
Wraps GET /api/v2/conversations/emails/{emailId}
|
|
1670
|
+
|
|
1671
|
+
|
|
1672
|
+
### Example
|
|
1673
|
+
~~~ruby
|
|
1674
|
+
# load the gem
|
|
1675
|
+
require 'purecloudplatformclientv2'
|
|
1676
|
+
# setup authorization
|
|
1677
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1678
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1679
|
+
environment = "mypurecloud.com"
|
|
1680
|
+
|
|
1681
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1682
|
+
|
|
1683
|
+
PureCloud.configure do |config|
|
|
1684
|
+
config.access_token = @authToken
|
|
1685
|
+
end
|
|
1686
|
+
|
|
1687
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
1688
|
+
|
|
1689
|
+
email_id = "email_id_example" # String | emailId
|
|
1690
|
+
|
|
1691
|
+
|
|
1692
|
+
begin
|
|
1693
|
+
#Get email conversation
|
|
1694
|
+
result = api_instance.get_conversations_email(email_id)
|
|
1695
|
+
p result
|
|
1696
|
+
rescue PureCloud::ApiError => e
|
|
1697
|
+
puts "Exception when calling ConversationsApi->get_conversations_email: #{e}"
|
|
1698
|
+
end
|
|
1699
|
+
~~~
|
|
1700
|
+
|
|
1701
|
+
### Parameters
|
|
1702
|
+
|
|
1703
|
+
Name | Type | Description | Notes
|
|
1704
|
+
------------- | ------------- | ------------- | -------------
|
|
1705
|
+
**email_id** | **String**| emailId |
|
|
1706
|
+
{: class="table table-striped"}
|
|
1707
|
+
|
|
1708
|
+
|
|
1709
|
+
### Return type
|
|
1710
|
+
|
|
1711
|
+
[**EmailConversation**](EmailConversation.html)
|
|
1712
|
+
|
|
1713
|
+
### HTTP request headers
|
|
1714
|
+
|
|
1715
|
+
- **Content-Type**: application/json
|
|
1716
|
+
- **Accept**: application/json
|
|
1717
|
+
|
|
1718
|
+
|
|
1719
|
+
|
|
1720
|
+
<a name="get_conversations_email_message"></a>
|
|
1721
|
+
|
|
1722
|
+
## -[**EmailMessage**](EmailMessage.html) get_conversations_email_message(email_id, message_id)
|
|
1723
|
+
|
|
1724
|
+
Get conversation message
|
|
1725
|
+
|
|
1726
|
+
|
|
1727
|
+
|
|
1728
|
+
Wraps GET /api/v2/conversations/emails/{emailId}/messages/{messageId}
|
|
1729
|
+
|
|
1730
|
+
|
|
1731
|
+
### Example
|
|
1732
|
+
~~~ruby
|
|
1733
|
+
# load the gem
|
|
1734
|
+
require 'purecloudplatformclientv2'
|
|
1735
|
+
# setup authorization
|
|
1736
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1737
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1738
|
+
environment = "mypurecloud.com"
|
|
1739
|
+
|
|
1740
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1741
|
+
|
|
1742
|
+
PureCloud.configure do |config|
|
|
1743
|
+
config.access_token = @authToken
|
|
1744
|
+
end
|
|
1745
|
+
|
|
1746
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
1747
|
+
|
|
1748
|
+
email_id = "email_id_example" # String | emailId
|
|
1749
|
+
|
|
1750
|
+
message_id = "message_id_example" # String | messageId
|
|
1751
|
+
|
|
1752
|
+
|
|
1753
|
+
begin
|
|
1754
|
+
#Get conversation message
|
|
1755
|
+
result = api_instance.get_conversations_email_message(email_id, message_id)
|
|
1756
|
+
p result
|
|
1757
|
+
rescue PureCloud::ApiError => e
|
|
1758
|
+
puts "Exception when calling ConversationsApi->get_conversations_email_message: #{e}"
|
|
1759
|
+
end
|
|
1760
|
+
~~~
|
|
1761
|
+
|
|
1762
|
+
### Parameters
|
|
1763
|
+
|
|
1764
|
+
Name | Type | Description | Notes
|
|
1765
|
+
------------- | ------------- | ------------- | -------------
|
|
1766
|
+
**email_id** | **String**| emailId |
|
|
1767
|
+
**message_id** | **String**| messageId |
|
|
1768
|
+
{: class="table table-striped"}
|
|
1769
|
+
|
|
1770
|
+
|
|
1771
|
+
### Return type
|
|
1772
|
+
|
|
1773
|
+
[**EmailMessage**](EmailMessage.html)
|
|
1774
|
+
|
|
1775
|
+
### HTTP request headers
|
|
1776
|
+
|
|
1777
|
+
- **Content-Type**: application/json
|
|
1778
|
+
- **Accept**: application/json
|
|
1779
|
+
|
|
1780
|
+
|
|
1781
|
+
|
|
1782
|
+
<a name="get_conversations_email_messages"></a>
|
|
1783
|
+
|
|
1784
|
+
## -[**EmailMessageListing**](EmailMessageListing.html) get_conversations_email_messages(email_id)
|
|
1785
|
+
|
|
1786
|
+
Get conversation messages
|
|
1787
|
+
|
|
1788
|
+
|
|
1789
|
+
|
|
1790
|
+
Wraps GET /api/v2/conversations/emails/{emailId}/messages
|
|
1791
|
+
|
|
1792
|
+
|
|
1793
|
+
### Example
|
|
1794
|
+
~~~ruby
|
|
1795
|
+
# load the gem
|
|
1796
|
+
require 'purecloudplatformclientv2'
|
|
1797
|
+
# setup authorization
|
|
1798
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1799
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1800
|
+
environment = "mypurecloud.com"
|
|
1801
|
+
|
|
1802
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1803
|
+
|
|
1804
|
+
PureCloud.configure do |config|
|
|
1805
|
+
config.access_token = @authToken
|
|
1806
|
+
end
|
|
1807
|
+
|
|
1808
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
1809
|
+
|
|
1810
|
+
email_id = "email_id_example" # String | emailId
|
|
1811
|
+
|
|
1812
|
+
|
|
1813
|
+
begin
|
|
1814
|
+
#Get conversation messages
|
|
1815
|
+
result = api_instance.get_conversations_email_messages(email_id)
|
|
1816
|
+
p result
|
|
1817
|
+
rescue PureCloud::ApiError => e
|
|
1818
|
+
puts "Exception when calling ConversationsApi->get_conversations_email_messages: #{e}"
|
|
1819
|
+
end
|
|
1820
|
+
~~~
|
|
1821
|
+
|
|
1822
|
+
### Parameters
|
|
1823
|
+
|
|
1824
|
+
Name | Type | Description | Notes
|
|
1825
|
+
------------- | ------------- | ------------- | -------------
|
|
1826
|
+
**email_id** | **String**| emailId |
|
|
1827
|
+
{: class="table table-striped"}
|
|
1828
|
+
|
|
1829
|
+
|
|
1830
|
+
### Return type
|
|
1831
|
+
|
|
1832
|
+
[**EmailMessageListing**](EmailMessageListing.html)
|
|
1833
|
+
|
|
1834
|
+
### HTTP request headers
|
|
1835
|
+
|
|
1836
|
+
- **Content-Type**: application/json
|
|
1837
|
+
- **Accept**: application/json
|
|
1838
|
+
|
|
1839
|
+
|
|
1840
|
+
|
|
1841
|
+
<a name="get_conversations_email_messages_draft"></a>
|
|
1842
|
+
|
|
1843
|
+
## -[**EmailMessage**](EmailMessage.html) get_conversations_email_messages_draft(email_id)
|
|
1844
|
+
|
|
1845
|
+
Get conversation draft reply
|
|
1846
|
+
|
|
1847
|
+
|
|
1848
|
+
|
|
1849
|
+
Wraps GET /api/v2/conversations/emails/{emailId}/messages/draft
|
|
1850
|
+
|
|
1851
|
+
|
|
1852
|
+
### Example
|
|
1853
|
+
~~~ruby
|
|
1854
|
+
# load the gem
|
|
1855
|
+
require 'purecloudplatformclientv2'
|
|
1856
|
+
# setup authorization
|
|
1857
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1858
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1859
|
+
environment = "mypurecloud.com"
|
|
1860
|
+
|
|
1861
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1862
|
+
|
|
1863
|
+
PureCloud.configure do |config|
|
|
1864
|
+
config.access_token = @authToken
|
|
1865
|
+
end
|
|
1866
|
+
|
|
1867
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
1868
|
+
|
|
1869
|
+
email_id = "email_id_example" # String | emailId
|
|
1870
|
+
|
|
1871
|
+
|
|
1872
|
+
begin
|
|
1873
|
+
#Get conversation draft reply
|
|
1874
|
+
result = api_instance.get_conversations_email_messages_draft(email_id)
|
|
1875
|
+
p result
|
|
1876
|
+
rescue PureCloud::ApiError => e
|
|
1877
|
+
puts "Exception when calling ConversationsApi->get_conversations_email_messages_draft: #{e}"
|
|
1878
|
+
end
|
|
1879
|
+
~~~
|
|
1880
|
+
|
|
1881
|
+
### Parameters
|
|
1882
|
+
|
|
1883
|
+
Name | Type | Description | Notes
|
|
1884
|
+
------------- | ------------- | ------------- | -------------
|
|
1885
|
+
**email_id** | **String**| emailId |
|
|
1886
|
+
{: class="table table-striped"}
|
|
1887
|
+
|
|
1888
|
+
|
|
1889
|
+
### Return type
|
|
1890
|
+
|
|
1891
|
+
[**EmailMessage**](EmailMessage.html)
|
|
1892
|
+
|
|
1893
|
+
### HTTP request headers
|
|
1894
|
+
|
|
1895
|
+
- **Content-Type**: application/json
|
|
1896
|
+
- **Accept**: application/json
|
|
1897
|
+
|
|
1898
|
+
|
|
1899
|
+
|
|
1900
|
+
<a name="get_conversations_email_participant_wrapup"></a>
|
|
1901
|
+
|
|
1902
|
+
## -[**Wrapup**](Wrapup.html) get_conversations_email_participant_wrapup(email_id, participant_id, opts)
|
|
1903
|
+
|
|
1904
|
+
Get the wrap-up for this conversation participant.
|
|
1905
|
+
|
|
1906
|
+
|
|
1907
|
+
|
|
1908
|
+
Wraps GET /api/v2/conversations/emails/{emailId}/participants/{participantId}/wrapup
|
|
1909
|
+
|
|
1910
|
+
|
|
1911
|
+
### Example
|
|
1912
|
+
~~~ruby
|
|
1913
|
+
# load the gem
|
|
1914
|
+
require 'purecloudplatformclientv2'
|
|
1915
|
+
# setup authorization
|
|
1916
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1917
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1918
|
+
environment = "mypurecloud.com"
|
|
1919
|
+
|
|
1920
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1921
|
+
|
|
1922
|
+
PureCloud.configure do |config|
|
|
1923
|
+
config.access_token = @authToken
|
|
1924
|
+
end
|
|
1925
|
+
|
|
1926
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
1927
|
+
|
|
1928
|
+
email_id = "email_id_example" # String | emailId
|
|
1929
|
+
|
|
1930
|
+
participant_id = "participant_id_example" # String | participantId
|
|
1931
|
+
|
|
1932
|
+
opts = {
|
|
1933
|
+
provisional: false # BOOLEAN | Indicates if the wrap-up code is provisional.
|
|
1934
|
+
}
|
|
1935
|
+
|
|
1936
|
+
begin
|
|
1937
|
+
#Get the wrap-up for this conversation participant.
|
|
1938
|
+
result = api_instance.get_conversations_email_participant_wrapup(email_id, participant_id, opts)
|
|
1939
|
+
p result
|
|
1940
|
+
rescue PureCloud::ApiError => e
|
|
1941
|
+
puts "Exception when calling ConversationsApi->get_conversations_email_participant_wrapup: #{e}"
|
|
1942
|
+
end
|
|
1943
|
+
~~~
|
|
1944
|
+
|
|
1945
|
+
### Parameters
|
|
1946
|
+
|
|
1947
|
+
Name | Type | Description | Notes
|
|
1948
|
+
------------- | ------------- | ------------- | -------------
|
|
1949
|
+
**email_id** | **String**| emailId |
|
|
1950
|
+
**participant_id** | **String**| participantId |
|
|
1951
|
+
**provisional** | **BOOLEAN**| Indicates if the wrap-up code is provisional. | [optional] [default to false]
|
|
1952
|
+
{: class="table table-striped"}
|
|
1953
|
+
|
|
1954
|
+
|
|
1955
|
+
### Return type
|
|
1956
|
+
|
|
1957
|
+
[**Wrapup**](Wrapup.html)
|
|
1958
|
+
|
|
1959
|
+
### HTTP request headers
|
|
1960
|
+
|
|
1961
|
+
- **Content-Type**: application/json
|
|
1962
|
+
- **Accept**: application/json
|
|
1963
|
+
|
|
1964
|
+
|
|
1965
|
+
|
|
1966
|
+
<a name="get_conversations_email_participant_wrapupcodes"></a>
|
|
1967
|
+
|
|
1968
|
+
## -[**Array<WrapupCode>**](WrapupCode.html) get_conversations_email_participant_wrapupcodes(email_id, participant_id)
|
|
1969
|
+
|
|
1970
|
+
Get list of wrapup codes for this conversation participant
|
|
1971
|
+
|
|
1972
|
+
|
|
1973
|
+
|
|
1974
|
+
Wraps GET /api/v2/conversations/emails/{emailId}/participants/{participantId}/wrapupcodes
|
|
1975
|
+
|
|
1976
|
+
|
|
1977
|
+
### Example
|
|
1978
|
+
~~~ruby
|
|
1979
|
+
# load the gem
|
|
1980
|
+
require 'purecloudplatformclientv2'
|
|
1981
|
+
# setup authorization
|
|
1982
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1983
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1984
|
+
environment = "mypurecloud.com"
|
|
1985
|
+
|
|
1986
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1987
|
+
|
|
1988
|
+
PureCloud.configure do |config|
|
|
1989
|
+
config.access_token = @authToken
|
|
1990
|
+
end
|
|
1991
|
+
|
|
1992
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
1993
|
+
|
|
1994
|
+
email_id = "email_id_example" # String | emailId
|
|
1995
|
+
|
|
1996
|
+
participant_id = "participant_id_example" # String | participantId
|
|
1997
|
+
|
|
1998
|
+
|
|
1999
|
+
begin
|
|
2000
|
+
#Get list of wrapup codes for this conversation participant
|
|
2001
|
+
result = api_instance.get_conversations_email_participant_wrapupcodes(email_id, participant_id)
|
|
2002
|
+
p result
|
|
2003
|
+
rescue PureCloud::ApiError => e
|
|
2004
|
+
puts "Exception when calling ConversationsApi->get_conversations_email_participant_wrapupcodes: #{e}"
|
|
2005
|
+
end
|
|
2006
|
+
~~~
|
|
2007
|
+
|
|
2008
|
+
### Parameters
|
|
2009
|
+
|
|
2010
|
+
Name | Type | Description | Notes
|
|
2011
|
+
------------- | ------------- | ------------- | -------------
|
|
2012
|
+
**email_id** | **String**| emailId |
|
|
2013
|
+
**participant_id** | **String**| participantId |
|
|
2014
|
+
{: class="table table-striped"}
|
|
2015
|
+
|
|
2016
|
+
|
|
2017
|
+
### Return type
|
|
2018
|
+
|
|
2019
|
+
[**Array<WrapupCode>**](WrapupCode.html)
|
|
2020
|
+
|
|
2021
|
+
### HTTP request headers
|
|
2022
|
+
|
|
2023
|
+
- **Content-Type**: application/json
|
|
2024
|
+
- **Accept**: application/json
|
|
2025
|
+
|
|
2026
|
+
|
|
2027
|
+
|
|
2028
|
+
<a name="get_conversations_emails"></a>
|
|
2029
|
+
|
|
2030
|
+
## -[**EmailConversationEntityListing**](EmailConversationEntityListing.html) get_conversations_emails
|
|
2031
|
+
|
|
2032
|
+
Get recent email conversations
|
|
2033
|
+
|
|
2034
|
+
|
|
2035
|
+
|
|
2036
|
+
Wraps GET /api/v2/conversations/emails
|
|
2037
|
+
|
|
2038
|
+
|
|
2039
|
+
### Example
|
|
2040
|
+
~~~ruby
|
|
2041
|
+
# load the gem
|
|
2042
|
+
require 'purecloudplatformclientv2'
|
|
2043
|
+
# setup authorization
|
|
2044
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2045
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2046
|
+
environment = "mypurecloud.com"
|
|
2047
|
+
|
|
2048
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2049
|
+
|
|
2050
|
+
PureCloud.configure do |config|
|
|
2051
|
+
config.access_token = @authToken
|
|
2052
|
+
end
|
|
2053
|
+
|
|
2054
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
2055
|
+
|
|
2056
|
+
begin
|
|
2057
|
+
#Get recent email conversations
|
|
2058
|
+
result = api_instance.get_conversations_emails
|
|
2059
|
+
p result
|
|
2060
|
+
rescue PureCloud::ApiError => e
|
|
2061
|
+
puts "Exception when calling ConversationsApi->get_conversations_emails: #{e}"
|
|
2062
|
+
end
|
|
2063
|
+
~~~
|
|
2064
|
+
|
|
2065
|
+
### Parameters
|
|
2066
|
+
This endpoint does not need any parameter.
|
|
2067
|
+
{: class="table table-striped"}
|
|
2068
|
+
|
|
2069
|
+
|
|
2070
|
+
### Return type
|
|
2071
|
+
|
|
2072
|
+
[**EmailConversationEntityListing**](EmailConversationEntityListing.html)
|
|
2073
|
+
|
|
2074
|
+
### HTTP request headers
|
|
2075
|
+
|
|
2076
|
+
- **Content-Type**: application/json
|
|
2077
|
+
- **Accept**: application/json
|
|
2078
|
+
|
|
2079
|
+
|
|
2080
|
+
|
|
2081
|
+
<a name="patch_conversation_participant"></a>
|
|
2082
|
+
|
|
2083
|
+
## - patch_conversation_participant(conversation_id, participant_id, body)
|
|
2084
|
+
|
|
2085
|
+
Update a participant.
|
|
2086
|
+
|
|
2087
|
+
Update conversation participant.
|
|
2088
|
+
|
|
2089
|
+
Wraps PATCH /api/v2/conversations/{conversationId}/participants/{participantId}
|
|
2090
|
+
|
|
2091
|
+
|
|
2092
|
+
### Example
|
|
2093
|
+
~~~ruby
|
|
2094
|
+
# load the gem
|
|
2095
|
+
require 'purecloudplatformclientv2'
|
|
2096
|
+
# setup authorization
|
|
2097
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2098
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2099
|
+
environment = "mypurecloud.com"
|
|
2100
|
+
|
|
2101
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2102
|
+
|
|
2103
|
+
PureCloud.configure do |config|
|
|
2104
|
+
config.access_token = @authToken
|
|
2105
|
+
end
|
|
2106
|
+
|
|
2107
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
2108
|
+
|
|
2109
|
+
conversation_id = "conversation_id_example" # String | conversation ID
|
|
2110
|
+
|
|
2111
|
+
participant_id = "participant_id_example" # String | participant ID
|
|
2112
|
+
|
|
2113
|
+
body = PureCloud::MediaParticipantRequest.new # MediaParticipantRequest | Update request
|
|
2114
|
+
|
|
2115
|
+
|
|
2116
|
+
begin
|
|
2117
|
+
#Update a participant.
|
|
2118
|
+
api_instance.patch_conversation_participant(conversation_id, participant_id, body)
|
|
2119
|
+
rescue PureCloud::ApiError => e
|
|
2120
|
+
puts "Exception when calling ConversationsApi->patch_conversation_participant: #{e}"
|
|
2121
|
+
end
|
|
2122
|
+
~~~
|
|
2123
|
+
|
|
2124
|
+
### Parameters
|
|
2125
|
+
|
|
2126
|
+
Name | Type | Description | Notes
|
|
2127
|
+
------------- | ------------- | ------------- | -------------
|
|
2128
|
+
**conversation_id** | **String**| conversation ID |
|
|
2129
|
+
**participant_id** | **String**| participant ID |
|
|
2130
|
+
**body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)| Update request |
|
|
2131
|
+
{: class="table table-striped"}
|
|
2132
|
+
|
|
2133
|
+
|
|
2134
|
+
### Return type
|
|
2135
|
+
|
|
2136
|
+
nil (empty response body)
|
|
2137
|
+
|
|
2138
|
+
### HTTP request headers
|
|
2139
|
+
|
|
2140
|
+
- **Content-Type**: application/json
|
|
2141
|
+
- **Accept**: application/json
|
|
2142
|
+
|
|
2143
|
+
|
|
2144
|
+
|
|
2145
|
+
<a name="patch_conversation_participant_attributes"></a>
|
|
2146
|
+
|
|
2147
|
+
## - patch_conversation_participant_attributes(conversation_id, participant_id, body)
|
|
2148
|
+
|
|
2149
|
+
Update the attributes on a conversation participant.
|
|
2150
|
+
|
|
2151
|
+
|
|
2152
|
+
|
|
2153
|
+
Wraps PATCH /api/v2/conversations/{conversationId}/participants/{participantId}/attributes
|
|
2154
|
+
|
|
2155
|
+
|
|
2156
|
+
### Example
|
|
2157
|
+
~~~ruby
|
|
2158
|
+
# load the gem
|
|
2159
|
+
require 'purecloudplatformclientv2'
|
|
2160
|
+
# setup authorization
|
|
2161
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2162
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2163
|
+
environment = "mypurecloud.com"
|
|
2164
|
+
|
|
2165
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2166
|
+
|
|
2167
|
+
PureCloud.configure do |config|
|
|
2168
|
+
config.access_token = @authToken
|
|
2169
|
+
end
|
|
2170
|
+
|
|
2171
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
2172
|
+
|
|
2173
|
+
conversation_id = "conversation_id_example" # String | conversation ID
|
|
2174
|
+
|
|
2175
|
+
participant_id = "participant_id_example" # String | participant ID
|
|
2176
|
+
|
|
2177
|
+
body = PureCloud::ParticipantAttributes.new # ParticipantAttributes | Participant attributes
|
|
2178
|
+
|
|
2179
|
+
|
|
2180
|
+
begin
|
|
2181
|
+
#Update the attributes on a conversation participant.
|
|
2182
|
+
api_instance.patch_conversation_participant_attributes(conversation_id, participant_id, body)
|
|
2183
|
+
rescue PureCloud::ApiError => e
|
|
2184
|
+
puts "Exception when calling ConversationsApi->patch_conversation_participant_attributes: #{e}"
|
|
2185
|
+
end
|
|
2186
|
+
~~~
|
|
2187
|
+
|
|
2188
|
+
### Parameters
|
|
2189
|
+
|
|
2190
|
+
Name | Type | Description | Notes
|
|
2191
|
+
------------- | ------------- | ------------- | -------------
|
|
2192
|
+
**conversation_id** | **String**| conversation ID |
|
|
2193
|
+
**participant_id** | **String**| participant ID |
|
|
2194
|
+
**body** | [**ParticipantAttributes**](ParticipantAttributes.html)| Participant attributes |
|
|
2195
|
+
{: class="table table-striped"}
|
|
2196
|
+
|
|
2197
|
+
|
|
2198
|
+
### Return type
|
|
2199
|
+
|
|
2200
|
+
nil (empty response body)
|
|
2201
|
+
|
|
2202
|
+
### HTTP request headers
|
|
2203
|
+
|
|
2204
|
+
- **Content-Type**: application/json
|
|
2205
|
+
- **Accept**: application/json
|
|
2206
|
+
|
|
2207
|
+
|
|
2208
|
+
|
|
2209
|
+
<a name="patch_conversations_call"></a>
|
|
2210
|
+
|
|
2211
|
+
## -[**Conversation**](Conversation.html) patch_conversations_call(call_id, body)
|
|
2212
|
+
|
|
2213
|
+
Update a conversation by setting it's recording state, merging in other conversations to create a conference, or disconnecting all of the participants
|
|
2214
|
+
|
|
2215
|
+
|
|
2216
|
+
|
|
2217
|
+
Wraps PATCH /api/v2/conversations/calls/{callId}
|
|
2218
|
+
|
|
2219
|
+
|
|
2220
|
+
### Example
|
|
2221
|
+
~~~ruby
|
|
2222
|
+
# load the gem
|
|
2223
|
+
require 'purecloudplatformclientv2'
|
|
2224
|
+
# setup authorization
|
|
2225
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2226
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2227
|
+
environment = "mypurecloud.com"
|
|
2228
|
+
|
|
2229
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2230
|
+
|
|
2231
|
+
PureCloud.configure do |config|
|
|
2232
|
+
config.access_token = @authToken
|
|
2233
|
+
end
|
|
2234
|
+
|
|
2235
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
2236
|
+
|
|
2237
|
+
call_id = "call_id_example" # String | callId
|
|
2238
|
+
|
|
2239
|
+
body = PureCloud::Conversation.new # Conversation | Conversation
|
|
2240
|
+
|
|
2241
|
+
|
|
2242
|
+
begin
|
|
2243
|
+
#Update a conversation by setting it's recording state, merging in other conversations to create a conference, or disconnecting all of the participants
|
|
2244
|
+
result = api_instance.patch_conversations_call(call_id, body)
|
|
2245
|
+
p result
|
|
2246
|
+
rescue PureCloud::ApiError => e
|
|
2247
|
+
puts "Exception when calling ConversationsApi->patch_conversations_call: #{e}"
|
|
2248
|
+
end
|
|
2249
|
+
~~~
|
|
2250
|
+
|
|
2251
|
+
### Parameters
|
|
2252
|
+
|
|
2253
|
+
Name | Type | Description | Notes
|
|
2254
|
+
------------- | ------------- | ------------- | -------------
|
|
2255
|
+
**call_id** | **String**| callId |
|
|
2256
|
+
**body** | [**Conversation**](Conversation.html)| Conversation |
|
|
2257
|
+
{: class="table table-striped"}
|
|
2258
|
+
|
|
2259
|
+
|
|
2260
|
+
### Return type
|
|
2261
|
+
|
|
2262
|
+
[**Conversation**](Conversation.html)
|
|
2263
|
+
|
|
2264
|
+
### HTTP request headers
|
|
2265
|
+
|
|
2266
|
+
- **Content-Type**: application/json
|
|
2267
|
+
- **Accept**: application/json
|
|
2268
|
+
|
|
2269
|
+
|
|
2270
|
+
|
|
2271
|
+
<a name="patch_conversations_call_participant"></a>
|
|
2272
|
+
|
|
2273
|
+
## - patch_conversations_call_participant(call_id, participant_id, body)
|
|
2274
|
+
|
|
2275
|
+
Update conversation participant
|
|
2276
|
+
|
|
2277
|
+
|
|
2278
|
+
|
|
2279
|
+
Wraps PATCH /api/v2/conversations/calls/{callId}/participants/{participantId}
|
|
2280
|
+
|
|
2281
|
+
|
|
2282
|
+
### Example
|
|
2283
|
+
~~~ruby
|
|
2284
|
+
# load the gem
|
|
2285
|
+
require 'purecloudplatformclientv2'
|
|
2286
|
+
# setup authorization
|
|
2287
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2288
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2289
|
+
environment = "mypurecloud.com"
|
|
2290
|
+
|
|
2291
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2292
|
+
|
|
2293
|
+
PureCloud.configure do |config|
|
|
2294
|
+
config.access_token = @authToken
|
|
2295
|
+
end
|
|
2296
|
+
|
|
2297
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
2298
|
+
|
|
2299
|
+
call_id = "call_id_example" # String | callId
|
|
2300
|
+
|
|
2301
|
+
participant_id = "participant_id_example" # String | participantId
|
|
2302
|
+
|
|
2303
|
+
body = PureCloud::MediaParticipantRequest.new # MediaParticipantRequest | Participant request
|
|
2304
|
+
|
|
2305
|
+
|
|
2306
|
+
begin
|
|
2307
|
+
#Update conversation participant
|
|
2308
|
+
api_instance.patch_conversations_call_participant(call_id, participant_id, body)
|
|
2309
|
+
rescue PureCloud::ApiError => e
|
|
2310
|
+
puts "Exception when calling ConversationsApi->patch_conversations_call_participant: #{e}"
|
|
2311
|
+
end
|
|
2312
|
+
~~~
|
|
2313
|
+
|
|
2314
|
+
### Parameters
|
|
2315
|
+
|
|
2316
|
+
Name | Type | Description | Notes
|
|
2317
|
+
------------- | ------------- | ------------- | -------------
|
|
2318
|
+
**call_id** | **String**| callId |
|
|
2319
|
+
**participant_id** | **String**| participantId |
|
|
2320
|
+
**body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)| Participant request |
|
|
2321
|
+
{: class="table table-striped"}
|
|
2322
|
+
|
|
2323
|
+
|
|
2324
|
+
### Return type
|
|
2325
|
+
|
|
2326
|
+
nil (empty response body)
|
|
2327
|
+
|
|
2328
|
+
### HTTP request headers
|
|
2329
|
+
|
|
2330
|
+
- **Content-Type**: application/json
|
|
2331
|
+
- **Accept**: application/json
|
|
2332
|
+
|
|
2333
|
+
|
|
2334
|
+
|
|
2335
|
+
<a name="patch_conversations_call_participant_attributes"></a>
|
|
2336
|
+
|
|
2337
|
+
## - patch_conversations_call_participant_attributes(call_id, participant_id, body)
|
|
2338
|
+
|
|
2339
|
+
Update the attributes on a conversation participant.
|
|
2340
|
+
|
|
2341
|
+
|
|
2342
|
+
|
|
2343
|
+
Wraps PATCH /api/v2/conversations/calls/{callId}/participants/{participantId}/attributes
|
|
2344
|
+
|
|
2345
|
+
|
|
2346
|
+
### Example
|
|
2347
|
+
~~~ruby
|
|
2348
|
+
# load the gem
|
|
2349
|
+
require 'purecloudplatformclientv2'
|
|
2350
|
+
# setup authorization
|
|
2351
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2352
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2353
|
+
environment = "mypurecloud.com"
|
|
2354
|
+
|
|
2355
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2356
|
+
|
|
2357
|
+
PureCloud.configure do |config|
|
|
2358
|
+
config.access_token = @authToken
|
|
2359
|
+
end
|
|
2360
|
+
|
|
2361
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
2362
|
+
|
|
2363
|
+
call_id = "call_id_example" # String | callId
|
|
2364
|
+
|
|
2365
|
+
participant_id = "participant_id_example" # String | participantId
|
|
2366
|
+
|
|
2367
|
+
body = PureCloud::ParticipantAttributes.new # ParticipantAttributes | Participant attributes
|
|
2368
|
+
|
|
2369
|
+
|
|
2370
|
+
begin
|
|
2371
|
+
#Update the attributes on a conversation participant.
|
|
2372
|
+
api_instance.patch_conversations_call_participant_attributes(call_id, participant_id, body)
|
|
2373
|
+
rescue PureCloud::ApiError => e
|
|
2374
|
+
puts "Exception when calling ConversationsApi->patch_conversations_call_participant_attributes: #{e}"
|
|
2375
|
+
end
|
|
2376
|
+
~~~
|
|
2377
|
+
|
|
2378
|
+
### Parameters
|
|
2379
|
+
|
|
2380
|
+
Name | Type | Description | Notes
|
|
2381
|
+
------------- | ------------- | ------------- | -------------
|
|
2382
|
+
**call_id** | **String**| callId |
|
|
2383
|
+
**participant_id** | **String**| participantId |
|
|
2384
|
+
**body** | [**ParticipantAttributes**](ParticipantAttributes.html)| Participant attributes |
|
|
2385
|
+
{: class="table table-striped"}
|
|
2386
|
+
|
|
2387
|
+
|
|
2388
|
+
### Return type
|
|
2389
|
+
|
|
2390
|
+
nil (empty response body)
|
|
2391
|
+
|
|
2392
|
+
### HTTP request headers
|
|
2393
|
+
|
|
2394
|
+
- **Content-Type**: application/json
|
|
2395
|
+
- **Accept**: application/json
|
|
2396
|
+
|
|
2397
|
+
|
|
2398
|
+
|
|
2399
|
+
<a name="patch_conversations_call_participant_communication"></a>
|
|
2400
|
+
|
|
2401
|
+
## -[**Empty**](Empty.html) patch_conversations_call_participant_communication(call_id, participant_id, communication_id, body)
|
|
2402
|
+
|
|
2403
|
+
Update conversation participant's communication by disconnecting it.
|
|
2404
|
+
|
|
2405
|
+
|
|
2406
|
+
|
|
2407
|
+
Wraps PATCH /api/v2/conversations/calls/{callId}/participants/{participantId}/communications/{communicationId}
|
|
2408
|
+
|
|
2409
|
+
|
|
2410
|
+
### Example
|
|
2411
|
+
~~~ruby
|
|
2412
|
+
# load the gem
|
|
2413
|
+
require 'purecloudplatformclientv2'
|
|
2414
|
+
# setup authorization
|
|
2415
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2416
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2417
|
+
environment = "mypurecloud.com"
|
|
2418
|
+
|
|
2419
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2420
|
+
|
|
2421
|
+
PureCloud.configure do |config|
|
|
2422
|
+
config.access_token = @authToken
|
|
2423
|
+
end
|
|
2424
|
+
|
|
2425
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
2426
|
+
|
|
2427
|
+
call_id = "call_id_example" # String | callId
|
|
2428
|
+
|
|
2429
|
+
participant_id = "participant_id_example" # String | participantId
|
|
2430
|
+
|
|
2431
|
+
communication_id = "communication_id_example" # String | communicationId
|
|
2432
|
+
|
|
2433
|
+
body = PureCloud::MediaParticipantRequest.new # MediaParticipantRequest | Participant
|
|
2434
|
+
|
|
2435
|
+
|
|
2436
|
+
begin
|
|
2437
|
+
#Update conversation participant's communication by disconnecting it.
|
|
2438
|
+
result = api_instance.patch_conversations_call_participant_communication(call_id, participant_id, communication_id, body)
|
|
2439
|
+
p result
|
|
2440
|
+
rescue PureCloud::ApiError => e
|
|
2441
|
+
puts "Exception when calling ConversationsApi->patch_conversations_call_participant_communication: #{e}"
|
|
2442
|
+
end
|
|
2443
|
+
~~~
|
|
2444
|
+
|
|
2445
|
+
### Parameters
|
|
2446
|
+
|
|
2447
|
+
Name | Type | Description | Notes
|
|
2448
|
+
------------- | ------------- | ------------- | -------------
|
|
2449
|
+
**call_id** | **String**| callId |
|
|
2450
|
+
**participant_id** | **String**| participantId |
|
|
2451
|
+
**communication_id** | **String**| communicationId |
|
|
2452
|
+
**body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)| Participant |
|
|
2453
|
+
{: class="table table-striped"}
|
|
2454
|
+
|
|
2455
|
+
|
|
2456
|
+
### Return type
|
|
2457
|
+
|
|
2458
|
+
[**Empty**](Empty.html)
|
|
2459
|
+
|
|
2460
|
+
### HTTP request headers
|
|
2461
|
+
|
|
2462
|
+
- **Content-Type**: application/json
|
|
2463
|
+
- **Accept**: application/json
|
|
2464
|
+
|
|
2465
|
+
|
|
2466
|
+
|
|
2467
|
+
<a name="patch_conversations_call_participant_consult"></a>
|
|
2468
|
+
|
|
2469
|
+
## -[**ConsultTransferResponse**](ConsultTransferResponse.html) patch_conversations_call_participant_consult(call_id, participant_id, body)
|
|
2470
|
+
|
|
2471
|
+
Change who can speak
|
|
2472
|
+
|
|
2473
|
+
|
|
2474
|
+
|
|
2475
|
+
Wraps PATCH /api/v2/conversations/calls/{callId}/participants/{participantId}/consult
|
|
2476
|
+
|
|
2477
|
+
|
|
2478
|
+
### Example
|
|
2479
|
+
~~~ruby
|
|
2480
|
+
# load the gem
|
|
2481
|
+
require 'purecloudplatformclientv2'
|
|
2482
|
+
# setup authorization
|
|
2483
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2484
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2485
|
+
environment = "mypurecloud.com"
|
|
2486
|
+
|
|
2487
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2488
|
+
|
|
2489
|
+
PureCloud.configure do |config|
|
|
2490
|
+
config.access_token = @authToken
|
|
2491
|
+
end
|
|
2492
|
+
|
|
2493
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
2494
|
+
|
|
2495
|
+
call_id = "call_id_example" # String | callId
|
|
2496
|
+
|
|
2497
|
+
participant_id = "participant_id_example" # String | participantId
|
|
2498
|
+
|
|
2499
|
+
body = PureCloud::ConsultTransferUpdate.new # ConsultTransferUpdate | new speak to
|
|
2500
|
+
|
|
2501
|
+
|
|
2502
|
+
begin
|
|
2503
|
+
#Change who can speak
|
|
2504
|
+
result = api_instance.patch_conversations_call_participant_consult(call_id, participant_id, body)
|
|
2505
|
+
p result
|
|
2506
|
+
rescue PureCloud::ApiError => e
|
|
2507
|
+
puts "Exception when calling ConversationsApi->patch_conversations_call_participant_consult: #{e}"
|
|
2508
|
+
end
|
|
2509
|
+
~~~
|
|
2510
|
+
|
|
2511
|
+
### Parameters
|
|
2512
|
+
|
|
2513
|
+
Name | Type | Description | Notes
|
|
2514
|
+
------------- | ------------- | ------------- | -------------
|
|
2515
|
+
**call_id** | **String**| callId |
|
|
2516
|
+
**participant_id** | **String**| participantId |
|
|
2517
|
+
**body** | [**ConsultTransferUpdate**](ConsultTransferUpdate.html)| new speak to |
|
|
2518
|
+
{: class="table table-striped"}
|
|
2519
|
+
|
|
2520
|
+
|
|
2521
|
+
### Return type
|
|
2522
|
+
|
|
2523
|
+
[**ConsultTransferResponse**](ConsultTransferResponse.html)
|
|
2524
|
+
|
|
2525
|
+
### HTTP request headers
|
|
2526
|
+
|
|
2527
|
+
- **Content-Type**: application/json
|
|
2528
|
+
- **Accept**: application/json
|
|
2529
|
+
|
|
2530
|
+
|
|
2531
|
+
|
|
2532
|
+
<a name="patch_conversations_callback"></a>
|
|
2533
|
+
|
|
2534
|
+
## -[**Conversation**](Conversation.html) patch_conversations_callback(callback_id, body)
|
|
2535
|
+
|
|
2536
|
+
Update a conversation by disconnecting all of the participants
|
|
2537
|
+
|
|
2538
|
+
|
|
2539
|
+
|
|
2540
|
+
Wraps PATCH /api/v2/conversations/callbacks/{callbackId}
|
|
2541
|
+
|
|
2542
|
+
|
|
2543
|
+
### Example
|
|
2544
|
+
~~~ruby
|
|
2545
|
+
# load the gem
|
|
2546
|
+
require 'purecloudplatformclientv2'
|
|
2547
|
+
# setup authorization
|
|
2548
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2549
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2550
|
+
environment = "mypurecloud.com"
|
|
2551
|
+
|
|
2552
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2553
|
+
|
|
2554
|
+
PureCloud.configure do |config|
|
|
2555
|
+
config.access_token = @authToken
|
|
2556
|
+
end
|
|
2557
|
+
|
|
2558
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
2559
|
+
|
|
2560
|
+
callback_id = "callback_id_example" # String | callbackId
|
|
2561
|
+
|
|
2562
|
+
body = PureCloud::Conversation.new # Conversation | Conversation
|
|
2563
|
+
|
|
2564
|
+
|
|
2565
|
+
begin
|
|
2566
|
+
#Update a conversation by disconnecting all of the participants
|
|
2567
|
+
result = api_instance.patch_conversations_callback(callback_id, body)
|
|
2568
|
+
p result
|
|
2569
|
+
rescue PureCloud::ApiError => e
|
|
2570
|
+
puts "Exception when calling ConversationsApi->patch_conversations_callback: #{e}"
|
|
2571
|
+
end
|
|
2572
|
+
~~~
|
|
2573
|
+
|
|
2574
|
+
### Parameters
|
|
2575
|
+
|
|
2576
|
+
Name | Type | Description | Notes
|
|
2577
|
+
------------- | ------------- | ------------- | -------------
|
|
2578
|
+
**callback_id** | **String**| callbackId |
|
|
2579
|
+
**body** | [**Conversation**](Conversation.html)| Conversation |
|
|
2580
|
+
{: class="table table-striped"}
|
|
2581
|
+
|
|
2582
|
+
|
|
2583
|
+
### Return type
|
|
2584
|
+
|
|
2585
|
+
[**Conversation**](Conversation.html)
|
|
2586
|
+
|
|
2587
|
+
### HTTP request headers
|
|
2588
|
+
|
|
2589
|
+
- **Content-Type**: application/json
|
|
2590
|
+
- **Accept**: application/json
|
|
2591
|
+
|
|
2592
|
+
|
|
2593
|
+
|
|
2594
|
+
<a name="patch_conversations_callback_participant"></a>
|
|
2595
|
+
|
|
2596
|
+
## - patch_conversations_callback_participant(callback_id, participant_id, body)
|
|
2597
|
+
|
|
2598
|
+
Update conversation participant
|
|
2599
|
+
|
|
2600
|
+
|
|
2601
|
+
|
|
2602
|
+
Wraps PATCH /api/v2/conversations/callbacks/{callbackId}/participants/{participantId}
|
|
2603
|
+
|
|
2604
|
+
|
|
2605
|
+
### Example
|
|
2606
|
+
~~~ruby
|
|
2607
|
+
# load the gem
|
|
2608
|
+
require 'purecloudplatformclientv2'
|
|
2609
|
+
# setup authorization
|
|
2610
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2611
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2612
|
+
environment = "mypurecloud.com"
|
|
2613
|
+
|
|
2614
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2615
|
+
|
|
2616
|
+
PureCloud.configure do |config|
|
|
2617
|
+
config.access_token = @authToken
|
|
2618
|
+
end
|
|
2619
|
+
|
|
2620
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
2621
|
+
|
|
2622
|
+
callback_id = "callback_id_example" # String | callbackId
|
|
2623
|
+
|
|
2624
|
+
participant_id = "participant_id_example" # String | participantId
|
|
2625
|
+
|
|
2626
|
+
body = PureCloud::MediaParticipantRequest.new # MediaParticipantRequest | Participant
|
|
2627
|
+
|
|
2628
|
+
|
|
2629
|
+
begin
|
|
2630
|
+
#Update conversation participant
|
|
2631
|
+
api_instance.patch_conversations_callback_participant(callback_id, participant_id, body)
|
|
2632
|
+
rescue PureCloud::ApiError => e
|
|
2633
|
+
puts "Exception when calling ConversationsApi->patch_conversations_callback_participant: #{e}"
|
|
2634
|
+
end
|
|
2635
|
+
~~~
|
|
2636
|
+
|
|
2637
|
+
### Parameters
|
|
2638
|
+
|
|
2639
|
+
Name | Type | Description | Notes
|
|
2640
|
+
------------- | ------------- | ------------- | -------------
|
|
2641
|
+
**callback_id** | **String**| callbackId |
|
|
2642
|
+
**participant_id** | **String**| participantId |
|
|
2643
|
+
**body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)| Participant |
|
|
2644
|
+
{: class="table table-striped"}
|
|
2645
|
+
|
|
2646
|
+
|
|
2647
|
+
### Return type
|
|
2648
|
+
|
|
2649
|
+
nil (empty response body)
|
|
2650
|
+
|
|
2651
|
+
### HTTP request headers
|
|
2652
|
+
|
|
2653
|
+
- **Content-Type**: application/json
|
|
2654
|
+
- **Accept**: application/json
|
|
2655
|
+
|
|
2656
|
+
|
|
2657
|
+
|
|
2658
|
+
<a name="patch_conversations_callback_participant_attributes"></a>
|
|
2659
|
+
|
|
2660
|
+
## - patch_conversations_callback_participant_attributes(callback_id, participant_id, body)
|
|
2661
|
+
|
|
2662
|
+
Update the attributes on a conversation participant.
|
|
2663
|
+
|
|
2664
|
+
|
|
2665
|
+
|
|
2666
|
+
Wraps PATCH /api/v2/conversations/callbacks/{callbackId}/participants/{participantId}/attributes
|
|
2667
|
+
|
|
2668
|
+
|
|
2669
|
+
### Example
|
|
2670
|
+
~~~ruby
|
|
2671
|
+
# load the gem
|
|
2672
|
+
require 'purecloudplatformclientv2'
|
|
2673
|
+
# setup authorization
|
|
2674
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2675
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2676
|
+
environment = "mypurecloud.com"
|
|
2677
|
+
|
|
2678
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2679
|
+
|
|
2680
|
+
PureCloud.configure do |config|
|
|
2681
|
+
config.access_token = @authToken
|
|
2682
|
+
end
|
|
2683
|
+
|
|
2684
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
2685
|
+
|
|
2686
|
+
callback_id = "callback_id_example" # String | callbackId
|
|
2687
|
+
|
|
2688
|
+
participant_id = "participant_id_example" # String | participantId
|
|
2689
|
+
|
|
2690
|
+
body = PureCloud::ParticipantAttributes.new # ParticipantAttributes | Attributes
|
|
2691
|
+
|
|
2692
|
+
|
|
2693
|
+
begin
|
|
2694
|
+
#Update the attributes on a conversation participant.
|
|
2695
|
+
api_instance.patch_conversations_callback_participant_attributes(callback_id, participant_id, body)
|
|
2696
|
+
rescue PureCloud::ApiError => e
|
|
2697
|
+
puts "Exception when calling ConversationsApi->patch_conversations_callback_participant_attributes: #{e}"
|
|
2698
|
+
end
|
|
2699
|
+
~~~
|
|
2700
|
+
|
|
2701
|
+
### Parameters
|
|
2702
|
+
|
|
2703
|
+
Name | Type | Description | Notes
|
|
2704
|
+
------------- | ------------- | ------------- | -------------
|
|
2705
|
+
**callback_id** | **String**| callbackId |
|
|
2706
|
+
**participant_id** | **String**| participantId |
|
|
2707
|
+
**body** | [**ParticipantAttributes**](ParticipantAttributes.html)| Attributes |
|
|
2708
|
+
{: class="table table-striped"}
|
|
2709
|
+
|
|
2710
|
+
|
|
2711
|
+
### Return type
|
|
2712
|
+
|
|
2713
|
+
nil (empty response body)
|
|
2714
|
+
|
|
2715
|
+
### HTTP request headers
|
|
2716
|
+
|
|
2717
|
+
- **Content-Type**: application/json
|
|
2718
|
+
- **Accept**: application/json
|
|
2719
|
+
|
|
2720
|
+
|
|
2721
|
+
|
|
2722
|
+
<a name="patch_conversations_callback_participant_communication"></a>
|
|
2723
|
+
|
|
2724
|
+
## -[**Empty**](Empty.html) patch_conversations_callback_participant_communication(callback_id, participant_id, communication_id, body)
|
|
2725
|
+
|
|
2726
|
+
Update conversation participant's communication by disconnecting it.
|
|
2727
|
+
|
|
2728
|
+
|
|
2729
|
+
|
|
2730
|
+
Wraps PATCH /api/v2/conversations/callbacks/{callbackId}/participants/{participantId}/communications/{communicationId}
|
|
2731
|
+
|
|
2732
|
+
|
|
2733
|
+
### Example
|
|
2734
|
+
~~~ruby
|
|
2735
|
+
# load the gem
|
|
2736
|
+
require 'purecloudplatformclientv2'
|
|
2737
|
+
# setup authorization
|
|
2738
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2739
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2740
|
+
environment = "mypurecloud.com"
|
|
2741
|
+
|
|
2742
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2743
|
+
|
|
2744
|
+
PureCloud.configure do |config|
|
|
2745
|
+
config.access_token = @authToken
|
|
2746
|
+
end
|
|
2747
|
+
|
|
2748
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
2749
|
+
|
|
2750
|
+
callback_id = "callback_id_example" # String | callbackId
|
|
2751
|
+
|
|
2752
|
+
participant_id = "participant_id_example" # String | participantId
|
|
2753
|
+
|
|
2754
|
+
communication_id = "communication_id_example" # String | communicationId
|
|
2755
|
+
|
|
2756
|
+
body = PureCloud::MediaParticipantRequest.new # MediaParticipantRequest | Participant
|
|
2757
|
+
|
|
2758
|
+
|
|
2759
|
+
begin
|
|
2760
|
+
#Update conversation participant's communication by disconnecting it.
|
|
2761
|
+
result = api_instance.patch_conversations_callback_participant_communication(callback_id, participant_id, communication_id, body)
|
|
2762
|
+
p result
|
|
2763
|
+
rescue PureCloud::ApiError => e
|
|
2764
|
+
puts "Exception when calling ConversationsApi->patch_conversations_callback_participant_communication: #{e}"
|
|
2765
|
+
end
|
|
2766
|
+
~~~
|
|
2767
|
+
|
|
2768
|
+
### Parameters
|
|
2769
|
+
|
|
2770
|
+
Name | Type | Description | Notes
|
|
2771
|
+
------------- | ------------- | ------------- | -------------
|
|
2772
|
+
**callback_id** | **String**| callbackId |
|
|
2773
|
+
**participant_id** | **String**| participantId |
|
|
2774
|
+
**communication_id** | **String**| communicationId |
|
|
2775
|
+
**body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)| Participant |
|
|
2776
|
+
{: class="table table-striped"}
|
|
2777
|
+
|
|
2778
|
+
|
|
2779
|
+
### Return type
|
|
2780
|
+
|
|
2781
|
+
[**Empty**](Empty.html)
|
|
2782
|
+
|
|
2783
|
+
### HTTP request headers
|
|
2784
|
+
|
|
2785
|
+
- **Content-Type**: application/json
|
|
2786
|
+
- **Accept**: application/json
|
|
2787
|
+
|
|
2788
|
+
|
|
2789
|
+
|
|
2790
|
+
<a name="patch_conversations_chat"></a>
|
|
2791
|
+
|
|
2792
|
+
## -[**Conversation**](Conversation.html) patch_conversations_chat(chat_id, body)
|
|
2793
|
+
|
|
2794
|
+
Update a conversation by disconnecting all of the participants
|
|
2795
|
+
|
|
2796
|
+
|
|
2797
|
+
|
|
2798
|
+
Wraps PATCH /api/v2/conversations/chats/{chatId}
|
|
2799
|
+
|
|
2800
|
+
|
|
2801
|
+
### Example
|
|
2802
|
+
~~~ruby
|
|
2803
|
+
# load the gem
|
|
2804
|
+
require 'purecloudplatformclientv2'
|
|
2805
|
+
# setup authorization
|
|
2806
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2807
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2808
|
+
environment = "mypurecloud.com"
|
|
2809
|
+
|
|
2810
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2811
|
+
|
|
2812
|
+
PureCloud.configure do |config|
|
|
2813
|
+
config.access_token = @authToken
|
|
2814
|
+
end
|
|
2815
|
+
|
|
2816
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
2817
|
+
|
|
2818
|
+
chat_id = "chat_id_example" # String | chatId
|
|
2819
|
+
|
|
2820
|
+
body = PureCloud::Conversation.new # Conversation | Conversation
|
|
2821
|
+
|
|
2822
|
+
|
|
2823
|
+
begin
|
|
2824
|
+
#Update a conversation by disconnecting all of the participants
|
|
2825
|
+
result = api_instance.patch_conversations_chat(chat_id, body)
|
|
2826
|
+
p result
|
|
2827
|
+
rescue PureCloud::ApiError => e
|
|
2828
|
+
puts "Exception when calling ConversationsApi->patch_conversations_chat: #{e}"
|
|
2829
|
+
end
|
|
2830
|
+
~~~
|
|
2831
|
+
|
|
2832
|
+
### Parameters
|
|
2833
|
+
|
|
2834
|
+
Name | Type | Description | Notes
|
|
2835
|
+
------------- | ------------- | ------------- | -------------
|
|
2836
|
+
**chat_id** | **String**| chatId |
|
|
2837
|
+
**body** | [**Conversation**](Conversation.html)| Conversation |
|
|
2838
|
+
{: class="table table-striped"}
|
|
2839
|
+
|
|
2840
|
+
|
|
2841
|
+
### Return type
|
|
2842
|
+
|
|
2843
|
+
[**Conversation**](Conversation.html)
|
|
2844
|
+
|
|
2845
|
+
### HTTP request headers
|
|
2846
|
+
|
|
2847
|
+
- **Content-Type**: application/json
|
|
2848
|
+
- **Accept**: application/json
|
|
2849
|
+
|
|
2850
|
+
|
|
2851
|
+
|
|
2852
|
+
<a name="patch_conversations_chat_participant"></a>
|
|
2853
|
+
|
|
2854
|
+
## - patch_conversations_chat_participant(chat_id, participant_id, body)
|
|
2855
|
+
|
|
2856
|
+
Update conversation participant
|
|
2857
|
+
|
|
2858
|
+
|
|
2859
|
+
|
|
2860
|
+
Wraps PATCH /api/v2/conversations/chats/{chatId}/participants/{participantId}
|
|
2861
|
+
|
|
2862
|
+
|
|
2863
|
+
### Example
|
|
2864
|
+
~~~ruby
|
|
2865
|
+
# load the gem
|
|
2866
|
+
require 'purecloudplatformclientv2'
|
|
2867
|
+
# setup authorization
|
|
2868
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2869
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2870
|
+
environment = "mypurecloud.com"
|
|
2871
|
+
|
|
2872
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2873
|
+
|
|
2874
|
+
PureCloud.configure do |config|
|
|
2875
|
+
config.access_token = @authToken
|
|
2876
|
+
end
|
|
2877
|
+
|
|
2878
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
2879
|
+
|
|
2880
|
+
chat_id = "chat_id_example" # String | chatId
|
|
2881
|
+
|
|
2882
|
+
participant_id = "participant_id_example" # String | participantId
|
|
2883
|
+
|
|
2884
|
+
body = PureCloud::MediaParticipantRequest.new # MediaParticipantRequest | Update request
|
|
2885
|
+
|
|
2886
|
+
|
|
2887
|
+
begin
|
|
2888
|
+
#Update conversation participant
|
|
2889
|
+
api_instance.patch_conversations_chat_participant(chat_id, participant_id, body)
|
|
2890
|
+
rescue PureCloud::ApiError => e
|
|
2891
|
+
puts "Exception when calling ConversationsApi->patch_conversations_chat_participant: #{e}"
|
|
2892
|
+
end
|
|
2893
|
+
~~~
|
|
2894
|
+
|
|
2895
|
+
### Parameters
|
|
2896
|
+
|
|
2897
|
+
Name | Type | Description | Notes
|
|
2898
|
+
------------- | ------------- | ------------- | -------------
|
|
2899
|
+
**chat_id** | **String**| chatId |
|
|
2900
|
+
**participant_id** | **String**| participantId |
|
|
2901
|
+
**body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)| Update request |
|
|
2902
|
+
{: class="table table-striped"}
|
|
2903
|
+
|
|
2904
|
+
|
|
2905
|
+
### Return type
|
|
2906
|
+
|
|
2907
|
+
nil (empty response body)
|
|
2908
|
+
|
|
2909
|
+
### HTTP request headers
|
|
2910
|
+
|
|
2911
|
+
- **Content-Type**: application/json
|
|
2912
|
+
- **Accept**: application/json
|
|
2913
|
+
|
|
2914
|
+
|
|
2915
|
+
|
|
2916
|
+
<a name="patch_conversations_chat_participant_attributes"></a>
|
|
2917
|
+
|
|
2918
|
+
## - patch_conversations_chat_participant_attributes(chat_id, participant_id, body)
|
|
2919
|
+
|
|
2920
|
+
Update the attributes on a conversation participant.
|
|
2921
|
+
|
|
2922
|
+
|
|
2923
|
+
|
|
2924
|
+
Wraps PATCH /api/v2/conversations/chats/{chatId}/participants/{participantId}/attributes
|
|
2925
|
+
|
|
2926
|
+
|
|
2927
|
+
### Example
|
|
2928
|
+
~~~ruby
|
|
2929
|
+
# load the gem
|
|
2930
|
+
require 'purecloudplatformclientv2'
|
|
2931
|
+
# setup authorization
|
|
2932
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2933
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2934
|
+
environment = "mypurecloud.com"
|
|
2935
|
+
|
|
2936
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2937
|
+
|
|
2938
|
+
PureCloud.configure do |config|
|
|
2939
|
+
config.access_token = @authToken
|
|
2940
|
+
end
|
|
2941
|
+
|
|
2942
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
2943
|
+
|
|
2944
|
+
chat_id = "chat_id_example" # String | chatId
|
|
2945
|
+
|
|
2946
|
+
participant_id = "participant_id_example" # String | participantId
|
|
2947
|
+
|
|
2948
|
+
body = PureCloud::ParticipantAttributes.new # ParticipantAttributes | Participant attributes
|
|
2949
|
+
|
|
2950
|
+
|
|
2951
|
+
begin
|
|
2952
|
+
#Update the attributes on a conversation participant.
|
|
2953
|
+
api_instance.patch_conversations_chat_participant_attributes(chat_id, participant_id, body)
|
|
2954
|
+
rescue PureCloud::ApiError => e
|
|
2955
|
+
puts "Exception when calling ConversationsApi->patch_conversations_chat_participant_attributes: #{e}"
|
|
2956
|
+
end
|
|
2957
|
+
~~~
|
|
2958
|
+
|
|
2959
|
+
### Parameters
|
|
2960
|
+
|
|
2961
|
+
Name | Type | Description | Notes
|
|
2962
|
+
------------- | ------------- | ------------- | -------------
|
|
2963
|
+
**chat_id** | **String**| chatId |
|
|
2964
|
+
**participant_id** | **String**| participantId |
|
|
2965
|
+
**body** | [**ParticipantAttributes**](ParticipantAttributes.html)| Participant attributes |
|
|
2966
|
+
{: class="table table-striped"}
|
|
2967
|
+
|
|
2968
|
+
|
|
2969
|
+
### Return type
|
|
2970
|
+
|
|
2971
|
+
nil (empty response body)
|
|
2972
|
+
|
|
2973
|
+
### HTTP request headers
|
|
2974
|
+
|
|
2975
|
+
- **Content-Type**: application/json
|
|
2976
|
+
- **Accept**: application/json
|
|
2977
|
+
|
|
2978
|
+
|
|
2979
|
+
|
|
2980
|
+
<a name="patch_conversations_chat_participant_communication"></a>
|
|
2981
|
+
|
|
2982
|
+
## -[**Empty**](Empty.html) patch_conversations_chat_participant_communication(chat_id, participant_id, communication_id, body)
|
|
2983
|
+
|
|
2984
|
+
Update conversation participant's communication by disconnecting it.
|
|
2985
|
+
|
|
2986
|
+
|
|
2987
|
+
|
|
2988
|
+
Wraps PATCH /api/v2/conversations/chats/{chatId}/participants/{participantId}/communications/{communicationId}
|
|
2989
|
+
|
|
2990
|
+
|
|
2991
|
+
### Example
|
|
2992
|
+
~~~ruby
|
|
2993
|
+
# load the gem
|
|
2994
|
+
require 'purecloudplatformclientv2'
|
|
2995
|
+
# setup authorization
|
|
2996
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2997
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2998
|
+
environment = "mypurecloud.com"
|
|
2999
|
+
|
|
3000
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
3001
|
+
|
|
3002
|
+
PureCloud.configure do |config|
|
|
3003
|
+
config.access_token = @authToken
|
|
3004
|
+
end
|
|
3005
|
+
|
|
3006
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
3007
|
+
|
|
3008
|
+
chat_id = "chat_id_example" # String | chatId
|
|
3009
|
+
|
|
3010
|
+
participant_id = "participant_id_example" # String | participantId
|
|
3011
|
+
|
|
3012
|
+
communication_id = "communication_id_example" # String | communicationId
|
|
3013
|
+
|
|
3014
|
+
body = PureCloud::MediaParticipantRequest.new # MediaParticipantRequest | Participant
|
|
3015
|
+
|
|
3016
|
+
|
|
3017
|
+
begin
|
|
3018
|
+
#Update conversation participant's communication by disconnecting it.
|
|
3019
|
+
result = api_instance.patch_conversations_chat_participant_communication(chat_id, participant_id, communication_id, body)
|
|
3020
|
+
p result
|
|
3021
|
+
rescue PureCloud::ApiError => e
|
|
3022
|
+
puts "Exception when calling ConversationsApi->patch_conversations_chat_participant_communication: #{e}"
|
|
3023
|
+
end
|
|
3024
|
+
~~~
|
|
3025
|
+
|
|
3026
|
+
### Parameters
|
|
3027
|
+
|
|
3028
|
+
Name | Type | Description | Notes
|
|
3029
|
+
------------- | ------------- | ------------- | -------------
|
|
3030
|
+
**chat_id** | **String**| chatId |
|
|
3031
|
+
**participant_id** | **String**| participantId |
|
|
3032
|
+
**communication_id** | **String**| communicationId |
|
|
3033
|
+
**body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)| Participant |
|
|
3034
|
+
{: class="table table-striped"}
|
|
3035
|
+
|
|
3036
|
+
|
|
3037
|
+
### Return type
|
|
3038
|
+
|
|
3039
|
+
[**Empty**](Empty.html)
|
|
3040
|
+
|
|
3041
|
+
### HTTP request headers
|
|
3042
|
+
|
|
3043
|
+
- **Content-Type**: application/json
|
|
3044
|
+
- **Accept**: application/json
|
|
3045
|
+
|
|
3046
|
+
|
|
3047
|
+
|
|
3048
|
+
<a name="patch_conversations_cobrowsesession"></a>
|
|
3049
|
+
|
|
3050
|
+
## -[**Conversation**](Conversation.html) patch_conversations_cobrowsesession(cobrowse_id, body)
|
|
3051
|
+
|
|
3052
|
+
Update a conversation by disconnecting all of the participants
|
|
3053
|
+
|
|
3054
|
+
|
|
3055
|
+
|
|
3056
|
+
Wraps PATCH /api/v2/conversations/cobrowsesessions/{cobrowseId}
|
|
3057
|
+
|
|
3058
|
+
|
|
3059
|
+
### Example
|
|
3060
|
+
~~~ruby
|
|
3061
|
+
# load the gem
|
|
3062
|
+
require 'purecloudplatformclientv2'
|
|
3063
|
+
# setup authorization
|
|
3064
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
3065
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
3066
|
+
environment = "mypurecloud.com"
|
|
3067
|
+
|
|
3068
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
3069
|
+
|
|
3070
|
+
PureCloud.configure do |config|
|
|
3071
|
+
config.access_token = @authToken
|
|
3072
|
+
end
|
|
3073
|
+
|
|
3074
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
3075
|
+
|
|
3076
|
+
cobrowse_id = "cobrowse_id_example" # String | cobrowseId
|
|
3077
|
+
|
|
3078
|
+
body = PureCloud::Conversation.new # Conversation | Conversation
|
|
3079
|
+
|
|
3080
|
+
|
|
3081
|
+
begin
|
|
3082
|
+
#Update a conversation by disconnecting all of the participants
|
|
3083
|
+
result = api_instance.patch_conversations_cobrowsesession(cobrowse_id, body)
|
|
3084
|
+
p result
|
|
3085
|
+
rescue PureCloud::ApiError => e
|
|
3086
|
+
puts "Exception when calling ConversationsApi->patch_conversations_cobrowsesession: #{e}"
|
|
3087
|
+
end
|
|
3088
|
+
~~~
|
|
3089
|
+
|
|
3090
|
+
### Parameters
|
|
3091
|
+
|
|
3092
|
+
Name | Type | Description | Notes
|
|
3093
|
+
------------- | ------------- | ------------- | -------------
|
|
3094
|
+
**cobrowse_id** | **String**| cobrowseId |
|
|
3095
|
+
**body** | [**Conversation**](Conversation.html)| Conversation |
|
|
3096
|
+
{: class="table table-striped"}
|
|
3097
|
+
|
|
3098
|
+
|
|
3099
|
+
### Return type
|
|
3100
|
+
|
|
3101
|
+
[**Conversation**](Conversation.html)
|
|
3102
|
+
|
|
3103
|
+
### HTTP request headers
|
|
3104
|
+
|
|
3105
|
+
- **Content-Type**: application/json
|
|
3106
|
+
- **Accept**: application/json
|
|
3107
|
+
|
|
3108
|
+
|
|
3109
|
+
|
|
3110
|
+
<a name="patch_conversations_cobrowsesession_participant"></a>
|
|
3111
|
+
|
|
3112
|
+
## - patch_conversations_cobrowsesession_participant(cobrowse_id, participant_id, opts)
|
|
3113
|
+
|
|
3114
|
+
Update conversation participant
|
|
3115
|
+
|
|
3116
|
+
|
|
3117
|
+
|
|
3118
|
+
Wraps PATCH /api/v2/conversations/cobrowsesessions/{cobrowseId}/participants/{participantId}
|
|
3119
|
+
|
|
3120
|
+
|
|
3121
|
+
### Example
|
|
3122
|
+
~~~ruby
|
|
3123
|
+
# load the gem
|
|
3124
|
+
require 'purecloudplatformclientv2'
|
|
3125
|
+
# setup authorization
|
|
3126
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
3127
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
3128
|
+
environment = "mypurecloud.com"
|
|
3129
|
+
|
|
3130
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
3131
|
+
|
|
3132
|
+
PureCloud.configure do |config|
|
|
3133
|
+
config.access_token = @authToken
|
|
3134
|
+
end
|
|
3135
|
+
|
|
3136
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
3137
|
+
|
|
3138
|
+
cobrowse_id = "cobrowse_id_example" # String | cobrowseId
|
|
3139
|
+
|
|
3140
|
+
participant_id = "participant_id_example" # String | participantId
|
|
3141
|
+
|
|
3142
|
+
opts = {
|
|
3143
|
+
body: PureCloud::MediaParticipantRequest.new # MediaParticipantRequest |
|
|
3144
|
+
}
|
|
3145
|
+
|
|
3146
|
+
begin
|
|
3147
|
+
#Update conversation participant
|
|
3148
|
+
api_instance.patch_conversations_cobrowsesession_participant(cobrowse_id, participant_id, opts)
|
|
3149
|
+
rescue PureCloud::ApiError => e
|
|
3150
|
+
puts "Exception when calling ConversationsApi->patch_conversations_cobrowsesession_participant: #{e}"
|
|
3151
|
+
end
|
|
3152
|
+
~~~
|
|
3153
|
+
|
|
3154
|
+
### Parameters
|
|
3155
|
+
|
|
3156
|
+
Name | Type | Description | Notes
|
|
3157
|
+
------------- | ------------- | ------------- | -------------
|
|
3158
|
+
**cobrowse_id** | **String**| cobrowseId |
|
|
3159
|
+
**participant_id** | **String**| participantId |
|
|
3160
|
+
**body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)| | [optional]
|
|
3161
|
+
{: class="table table-striped"}
|
|
3162
|
+
|
|
3163
|
+
|
|
3164
|
+
### Return type
|
|
3165
|
+
|
|
3166
|
+
nil (empty response body)
|
|
3167
|
+
|
|
3168
|
+
### HTTP request headers
|
|
3169
|
+
|
|
3170
|
+
- **Content-Type**: application/json
|
|
3171
|
+
- **Accept**: application/json
|
|
3172
|
+
|
|
3173
|
+
|
|
3174
|
+
|
|
3175
|
+
<a name="patch_conversations_cobrowsesession_participant_attributes"></a>
|
|
3176
|
+
|
|
3177
|
+
## - patch_conversations_cobrowsesession_participant_attributes(cobrowse_id, participant_id, opts)
|
|
3178
|
+
|
|
3179
|
+
Update the attributes on a conversation participant.
|
|
3180
|
+
|
|
3181
|
+
|
|
3182
|
+
|
|
3183
|
+
Wraps PATCH /api/v2/conversations/cobrowsesessions/{cobrowseId}/participants/{participantId}/attributes
|
|
3184
|
+
|
|
3185
|
+
|
|
3186
|
+
### Example
|
|
3187
|
+
~~~ruby
|
|
3188
|
+
# load the gem
|
|
3189
|
+
require 'purecloudplatformclientv2'
|
|
3190
|
+
# setup authorization
|
|
3191
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
3192
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
3193
|
+
environment = "mypurecloud.com"
|
|
3194
|
+
|
|
3195
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
3196
|
+
|
|
3197
|
+
PureCloud.configure do |config|
|
|
3198
|
+
config.access_token = @authToken
|
|
3199
|
+
end
|
|
3200
|
+
|
|
3201
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
3202
|
+
|
|
3203
|
+
cobrowse_id = "cobrowse_id_example" # String | cobrowseId
|
|
3204
|
+
|
|
3205
|
+
participant_id = "participant_id_example" # String | participantId
|
|
3206
|
+
|
|
3207
|
+
opts = {
|
|
3208
|
+
body: PureCloud::ParticipantAttributes.new # ParticipantAttributes |
|
|
3209
|
+
}
|
|
3210
|
+
|
|
3211
|
+
begin
|
|
3212
|
+
#Update the attributes on a conversation participant.
|
|
3213
|
+
api_instance.patch_conversations_cobrowsesession_participant_attributes(cobrowse_id, participant_id, opts)
|
|
3214
|
+
rescue PureCloud::ApiError => e
|
|
3215
|
+
puts "Exception when calling ConversationsApi->patch_conversations_cobrowsesession_participant_attributes: #{e}"
|
|
3216
|
+
end
|
|
3217
|
+
~~~
|
|
3218
|
+
|
|
3219
|
+
### Parameters
|
|
3220
|
+
|
|
3221
|
+
Name | Type | Description | Notes
|
|
3222
|
+
------------- | ------------- | ------------- | -------------
|
|
3223
|
+
**cobrowse_id** | **String**| cobrowseId |
|
|
3224
|
+
**participant_id** | **String**| participantId |
|
|
3225
|
+
**body** | [**ParticipantAttributes**](ParticipantAttributes.html)| | [optional]
|
|
3226
|
+
{: class="table table-striped"}
|
|
3227
|
+
|
|
3228
|
+
|
|
3229
|
+
### Return type
|
|
3230
|
+
|
|
3231
|
+
nil (empty response body)
|
|
3232
|
+
|
|
3233
|
+
### HTTP request headers
|
|
3234
|
+
|
|
3235
|
+
- **Content-Type**: application/json
|
|
3236
|
+
- **Accept**: application/json
|
|
3237
|
+
|
|
3238
|
+
|
|
3239
|
+
|
|
3240
|
+
<a name="patch_conversations_cobrowsesession_participant_communication"></a>
|
|
3241
|
+
|
|
3242
|
+
## -[**Empty**](Empty.html) patch_conversations_cobrowsesession_participant_communication(cobrowse_id, participant_id, communication_id, body)
|
|
3243
|
+
|
|
3244
|
+
Update conversation participant's communication by disconnecting it.
|
|
3245
|
+
|
|
3246
|
+
|
|
3247
|
+
|
|
3248
|
+
Wraps PATCH /api/v2/conversations/cobrowsesessions/{cobrowseId}/participants/{participantId}/communications/{communicationId}
|
|
3249
|
+
|
|
3250
|
+
|
|
3251
|
+
### Example
|
|
3252
|
+
~~~ruby
|
|
3253
|
+
# load the gem
|
|
3254
|
+
require 'purecloudplatformclientv2'
|
|
3255
|
+
# setup authorization
|
|
3256
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
3257
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
3258
|
+
environment = "mypurecloud.com"
|
|
3259
|
+
|
|
3260
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
3261
|
+
|
|
3262
|
+
PureCloud.configure do |config|
|
|
3263
|
+
config.access_token = @authToken
|
|
3264
|
+
end
|
|
3265
|
+
|
|
3266
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
3267
|
+
|
|
3268
|
+
cobrowse_id = "cobrowse_id_example" # String | cobrowseId
|
|
3269
|
+
|
|
3270
|
+
participant_id = "participant_id_example" # String | participantId
|
|
3271
|
+
|
|
3272
|
+
communication_id = "communication_id_example" # String | communicationId
|
|
3273
|
+
|
|
3274
|
+
body = PureCloud::MediaParticipantRequest.new # MediaParticipantRequest | Participant
|
|
3275
|
+
|
|
3276
|
+
|
|
3277
|
+
begin
|
|
3278
|
+
#Update conversation participant's communication by disconnecting it.
|
|
3279
|
+
result = api_instance.patch_conversations_cobrowsesession_participant_communication(cobrowse_id, participant_id, communication_id, body)
|
|
3280
|
+
p result
|
|
3281
|
+
rescue PureCloud::ApiError => e
|
|
3282
|
+
puts "Exception when calling ConversationsApi->patch_conversations_cobrowsesession_participant_communication: #{e}"
|
|
3283
|
+
end
|
|
3284
|
+
~~~
|
|
3285
|
+
|
|
3286
|
+
### Parameters
|
|
3287
|
+
|
|
3288
|
+
Name | Type | Description | Notes
|
|
3289
|
+
------------- | ------------- | ------------- | -------------
|
|
3290
|
+
**cobrowse_id** | **String**| cobrowseId |
|
|
3291
|
+
**participant_id** | **String**| participantId |
|
|
3292
|
+
**communication_id** | **String**| communicationId |
|
|
3293
|
+
**body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)| Participant |
|
|
3294
|
+
{: class="table table-striped"}
|
|
3295
|
+
|
|
3296
|
+
|
|
3297
|
+
### Return type
|
|
3298
|
+
|
|
3299
|
+
[**Empty**](Empty.html)
|
|
3300
|
+
|
|
3301
|
+
### HTTP request headers
|
|
3302
|
+
|
|
3303
|
+
- **Content-Type**: application/json
|
|
3304
|
+
- **Accept**: application/json
|
|
3305
|
+
|
|
3306
|
+
|
|
3307
|
+
|
|
3308
|
+
<a name="patch_conversations_email"></a>
|
|
3309
|
+
|
|
3310
|
+
## -[**Conversation**](Conversation.html) patch_conversations_email(email_id, body)
|
|
3311
|
+
|
|
3312
|
+
Update a conversation by disconnecting all of the participants
|
|
3313
|
+
|
|
3314
|
+
|
|
3315
|
+
|
|
3316
|
+
Wraps PATCH /api/v2/conversations/emails/{emailId}
|
|
3317
|
+
|
|
3318
|
+
|
|
3319
|
+
### Example
|
|
3320
|
+
~~~ruby
|
|
3321
|
+
# load the gem
|
|
3322
|
+
require 'purecloudplatformclientv2'
|
|
3323
|
+
# setup authorization
|
|
3324
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
3325
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
3326
|
+
environment = "mypurecloud.com"
|
|
3327
|
+
|
|
3328
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
3329
|
+
|
|
3330
|
+
PureCloud.configure do |config|
|
|
3331
|
+
config.access_token = @authToken
|
|
3332
|
+
end
|
|
3333
|
+
|
|
3334
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
3335
|
+
|
|
3336
|
+
email_id = "email_id_example" # String | emailId
|
|
3337
|
+
|
|
3338
|
+
body = PureCloud::Conversation.new # Conversation | Conversation
|
|
3339
|
+
|
|
3340
|
+
|
|
3341
|
+
begin
|
|
3342
|
+
#Update a conversation by disconnecting all of the participants
|
|
3343
|
+
result = api_instance.patch_conversations_email(email_id, body)
|
|
3344
|
+
p result
|
|
3345
|
+
rescue PureCloud::ApiError => e
|
|
3346
|
+
puts "Exception when calling ConversationsApi->patch_conversations_email: #{e}"
|
|
3347
|
+
end
|
|
3348
|
+
~~~
|
|
3349
|
+
|
|
3350
|
+
### Parameters
|
|
3351
|
+
|
|
3352
|
+
Name | Type | Description | Notes
|
|
3353
|
+
------------- | ------------- | ------------- | -------------
|
|
3354
|
+
**email_id** | **String**| emailId |
|
|
3355
|
+
**body** | [**Conversation**](Conversation.html)| Conversation |
|
|
3356
|
+
{: class="table table-striped"}
|
|
3357
|
+
|
|
3358
|
+
|
|
3359
|
+
### Return type
|
|
3360
|
+
|
|
3361
|
+
[**Conversation**](Conversation.html)
|
|
3362
|
+
|
|
3363
|
+
### HTTP request headers
|
|
3364
|
+
|
|
3365
|
+
- **Content-Type**: application/json
|
|
3366
|
+
- **Accept**: application/json
|
|
3367
|
+
|
|
3368
|
+
|
|
3369
|
+
|
|
3370
|
+
<a name="patch_conversations_email_participant"></a>
|
|
3371
|
+
|
|
3372
|
+
## - patch_conversations_email_participant(email_id, participant_id, body)
|
|
3373
|
+
|
|
3374
|
+
Update conversation participant
|
|
3375
|
+
|
|
3376
|
+
|
|
3377
|
+
|
|
3378
|
+
Wraps PATCH /api/v2/conversations/emails/{emailId}/participants/{participantId}
|
|
3379
|
+
|
|
3380
|
+
|
|
3381
|
+
### Example
|
|
3382
|
+
~~~ruby
|
|
3383
|
+
# load the gem
|
|
3384
|
+
require 'purecloudplatformclientv2'
|
|
3385
|
+
# setup authorization
|
|
3386
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
3387
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
3388
|
+
environment = "mypurecloud.com"
|
|
3389
|
+
|
|
3390
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
3391
|
+
|
|
3392
|
+
PureCloud.configure do |config|
|
|
3393
|
+
config.access_token = @authToken
|
|
3394
|
+
end
|
|
3395
|
+
|
|
3396
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
3397
|
+
|
|
3398
|
+
email_id = "email_id_example" # String | emailId
|
|
3399
|
+
|
|
3400
|
+
participant_id = "participant_id_example" # String | participantId
|
|
3401
|
+
|
|
3402
|
+
body = PureCloud::MediaParticipantRequest.new # MediaParticipantRequest | Update request
|
|
3403
|
+
|
|
3404
|
+
|
|
3405
|
+
begin
|
|
3406
|
+
#Update conversation participant
|
|
3407
|
+
api_instance.patch_conversations_email_participant(email_id, participant_id, body)
|
|
3408
|
+
rescue PureCloud::ApiError => e
|
|
3409
|
+
puts "Exception when calling ConversationsApi->patch_conversations_email_participant: #{e}"
|
|
3410
|
+
end
|
|
3411
|
+
~~~
|
|
3412
|
+
|
|
3413
|
+
### Parameters
|
|
3414
|
+
|
|
3415
|
+
Name | Type | Description | Notes
|
|
3416
|
+
------------- | ------------- | ------------- | -------------
|
|
3417
|
+
**email_id** | **String**| emailId |
|
|
3418
|
+
**participant_id** | **String**| participantId |
|
|
3419
|
+
**body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)| Update request |
|
|
3420
|
+
{: class="table table-striped"}
|
|
3421
|
+
|
|
3422
|
+
|
|
3423
|
+
### Return type
|
|
3424
|
+
|
|
3425
|
+
nil (empty response body)
|
|
3426
|
+
|
|
3427
|
+
### HTTP request headers
|
|
3428
|
+
|
|
3429
|
+
- **Content-Type**: application/json
|
|
3430
|
+
- **Accept**: application/json
|
|
3431
|
+
|
|
3432
|
+
|
|
3433
|
+
|
|
3434
|
+
<a name="patch_conversations_email_participant_attributes"></a>
|
|
3435
|
+
|
|
3436
|
+
## - patch_conversations_email_participant_attributes(email_id, participant_id, body)
|
|
3437
|
+
|
|
3438
|
+
Update the attributes on a conversation participant.
|
|
3439
|
+
|
|
3440
|
+
|
|
3441
|
+
|
|
3442
|
+
Wraps PATCH /api/v2/conversations/emails/{emailId}/participants/{participantId}/attributes
|
|
3443
|
+
|
|
3444
|
+
|
|
3445
|
+
### Example
|
|
3446
|
+
~~~ruby
|
|
3447
|
+
# load the gem
|
|
3448
|
+
require 'purecloudplatformclientv2'
|
|
3449
|
+
# setup authorization
|
|
3450
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
3451
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
3452
|
+
environment = "mypurecloud.com"
|
|
3453
|
+
|
|
3454
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
3455
|
+
|
|
3456
|
+
PureCloud.configure do |config|
|
|
3457
|
+
config.access_token = @authToken
|
|
3458
|
+
end
|
|
3459
|
+
|
|
3460
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
3461
|
+
|
|
3462
|
+
email_id = "email_id_example" # String | emailId
|
|
3463
|
+
|
|
3464
|
+
participant_id = "participant_id_example" # String | participantId
|
|
3465
|
+
|
|
3466
|
+
body = PureCloud::ParticipantAttributes.new # ParticipantAttributes | Participant attributes
|
|
3467
|
+
|
|
3468
|
+
|
|
3469
|
+
begin
|
|
3470
|
+
#Update the attributes on a conversation participant.
|
|
3471
|
+
api_instance.patch_conversations_email_participant_attributes(email_id, participant_id, body)
|
|
3472
|
+
rescue PureCloud::ApiError => e
|
|
3473
|
+
puts "Exception when calling ConversationsApi->patch_conversations_email_participant_attributes: #{e}"
|
|
3474
|
+
end
|
|
3475
|
+
~~~
|
|
3476
|
+
|
|
3477
|
+
### Parameters
|
|
3478
|
+
|
|
3479
|
+
Name | Type | Description | Notes
|
|
3480
|
+
------------- | ------------- | ------------- | -------------
|
|
3481
|
+
**email_id** | **String**| emailId |
|
|
3482
|
+
**participant_id** | **String**| participantId |
|
|
3483
|
+
**body** | [**ParticipantAttributes**](ParticipantAttributes.html)| Participant attributes |
|
|
3484
|
+
{: class="table table-striped"}
|
|
3485
|
+
|
|
3486
|
+
|
|
3487
|
+
### Return type
|
|
3488
|
+
|
|
3489
|
+
nil (empty response body)
|
|
3490
|
+
|
|
3491
|
+
### HTTP request headers
|
|
3492
|
+
|
|
3493
|
+
- **Content-Type**: application/json
|
|
3494
|
+
- **Accept**: application/json
|
|
3495
|
+
|
|
3496
|
+
|
|
3497
|
+
|
|
3498
|
+
<a name="patch_conversations_email_participant_communication"></a>
|
|
3499
|
+
|
|
3500
|
+
## -[**Empty**](Empty.html) patch_conversations_email_participant_communication(email_id, participant_id, communication_id, body)
|
|
3501
|
+
|
|
3502
|
+
Update conversation participant's communication by disconnecting it.
|
|
3503
|
+
|
|
3504
|
+
|
|
3505
|
+
|
|
3506
|
+
Wraps PATCH /api/v2/conversations/emails/{emailId}/participants/{participantId}/communications/{communicationId}
|
|
3507
|
+
|
|
3508
|
+
|
|
3509
|
+
### Example
|
|
3510
|
+
~~~ruby
|
|
3511
|
+
# load the gem
|
|
3512
|
+
require 'purecloudplatformclientv2'
|
|
3513
|
+
# setup authorization
|
|
3514
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
3515
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
3516
|
+
environment = "mypurecloud.com"
|
|
3517
|
+
|
|
3518
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
3519
|
+
|
|
3520
|
+
PureCloud.configure do |config|
|
|
3521
|
+
config.access_token = @authToken
|
|
3522
|
+
end
|
|
3523
|
+
|
|
3524
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
3525
|
+
|
|
3526
|
+
email_id = "email_id_example" # String | emailId
|
|
3527
|
+
|
|
3528
|
+
participant_id = "participant_id_example" # String | participantId
|
|
3529
|
+
|
|
3530
|
+
communication_id = "communication_id_example" # String | communicationId
|
|
3531
|
+
|
|
3532
|
+
body = PureCloud::MediaParticipantRequest.new # MediaParticipantRequest | Participant
|
|
3533
|
+
|
|
3534
|
+
|
|
3535
|
+
begin
|
|
3536
|
+
#Update conversation participant's communication by disconnecting it.
|
|
3537
|
+
result = api_instance.patch_conversations_email_participant_communication(email_id, participant_id, communication_id, body)
|
|
3538
|
+
p result
|
|
3539
|
+
rescue PureCloud::ApiError => e
|
|
3540
|
+
puts "Exception when calling ConversationsApi->patch_conversations_email_participant_communication: #{e}"
|
|
3541
|
+
end
|
|
3542
|
+
~~~
|
|
3543
|
+
|
|
3544
|
+
### Parameters
|
|
3545
|
+
|
|
3546
|
+
Name | Type | Description | Notes
|
|
3547
|
+
------------- | ------------- | ------------- | -------------
|
|
3548
|
+
**email_id** | **String**| emailId |
|
|
3549
|
+
**participant_id** | **String**| participantId |
|
|
3550
|
+
**communication_id** | **String**| communicationId |
|
|
3551
|
+
**body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)| Participant |
|
|
3552
|
+
{: class="table table-striped"}
|
|
3553
|
+
|
|
3554
|
+
|
|
3555
|
+
### Return type
|
|
3556
|
+
|
|
3557
|
+
[**Empty**](Empty.html)
|
|
3558
|
+
|
|
3559
|
+
### HTTP request headers
|
|
3560
|
+
|
|
3561
|
+
- **Content-Type**: application/json
|
|
3562
|
+
- **Accept**: application/json
|
|
3563
|
+
|
|
3564
|
+
|
|
3565
|
+
|
|
3566
|
+
<a name="post_analytics_conversation_details_properties"></a>
|
|
3567
|
+
|
|
3568
|
+
## -[**PropertyIndexRequest**](PropertyIndexRequest.html) post_analytics_conversation_details_properties(conversation_id, body)
|
|
3569
|
+
|
|
3570
|
+
Index conversation properties
|
|
3571
|
+
|
|
3572
|
+
|
|
3573
|
+
|
|
3574
|
+
Wraps POST /api/v2/analytics/conversations/{conversationId}/details/properties
|
|
3575
|
+
|
|
3576
|
+
|
|
3577
|
+
### Example
|
|
3578
|
+
~~~ruby
|
|
3579
|
+
# load the gem
|
|
3580
|
+
require 'purecloudplatformclientv2'
|
|
3581
|
+
# setup authorization
|
|
3582
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
3583
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
3584
|
+
environment = "mypurecloud.com"
|
|
3585
|
+
|
|
3586
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
3587
|
+
|
|
3588
|
+
PureCloud.configure do |config|
|
|
3589
|
+
config.access_token = @authToken
|
|
3590
|
+
end
|
|
3591
|
+
|
|
3592
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
3593
|
+
|
|
3594
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
3595
|
+
|
|
3596
|
+
body = PureCloud::PropertyIndexRequest.new # PropertyIndexRequest | request
|
|
3597
|
+
|
|
3598
|
+
|
|
3599
|
+
begin
|
|
3600
|
+
#Index conversation properties
|
|
3601
|
+
result = api_instance.post_analytics_conversation_details_properties(conversation_id, body)
|
|
3602
|
+
p result
|
|
3603
|
+
rescue PureCloud::ApiError => e
|
|
3604
|
+
puts "Exception when calling ConversationsApi->post_analytics_conversation_details_properties: #{e}"
|
|
3605
|
+
end
|
|
3606
|
+
~~~
|
|
3607
|
+
|
|
3608
|
+
### Parameters
|
|
3609
|
+
|
|
3610
|
+
Name | Type | Description | Notes
|
|
3611
|
+
------------- | ------------- | ------------- | -------------
|
|
3612
|
+
**conversation_id** | **String**| conversationId |
|
|
3613
|
+
**body** | [**PropertyIndexRequest**](PropertyIndexRequest.html)| request |
|
|
3614
|
+
{: class="table table-striped"}
|
|
3615
|
+
|
|
3616
|
+
|
|
3617
|
+
### Return type
|
|
3618
|
+
|
|
3619
|
+
[**PropertyIndexRequest**](PropertyIndexRequest.html)
|
|
3620
|
+
|
|
3621
|
+
### HTTP request headers
|
|
3622
|
+
|
|
3623
|
+
- **Content-Type**: application/json
|
|
3624
|
+
- **Accept**: application/json
|
|
3625
|
+
|
|
3626
|
+
|
|
3627
|
+
|
|
3628
|
+
<a name="post_analytics_conversations_aggregates_query"></a>
|
|
3629
|
+
|
|
3630
|
+
## -[**AggregateQueryResponse**](AggregateQueryResponse.html) post_analytics_conversations_aggregates_query(body)
|
|
3631
|
+
|
|
3632
|
+
Query for conversation aggregates
|
|
3633
|
+
|
|
3634
|
+
|
|
3635
|
+
|
|
3636
|
+
Wraps POST /api/v2/analytics/conversations/aggregates/query
|
|
3637
|
+
|
|
3638
|
+
|
|
3639
|
+
### Example
|
|
3640
|
+
~~~ruby
|
|
3641
|
+
# load the gem
|
|
3642
|
+
require 'purecloudplatformclientv2'
|
|
3643
|
+
# setup authorization
|
|
3644
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
3645
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
3646
|
+
environment = "mypurecloud.com"
|
|
3647
|
+
|
|
3648
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
3649
|
+
|
|
3650
|
+
PureCloud.configure do |config|
|
|
3651
|
+
config.access_token = @authToken
|
|
3652
|
+
end
|
|
3653
|
+
|
|
3654
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
3655
|
+
|
|
3656
|
+
body = PureCloud::AggregationQuery.new # AggregationQuery | query
|
|
3657
|
+
|
|
3658
|
+
|
|
3659
|
+
begin
|
|
3660
|
+
#Query for conversation aggregates
|
|
3661
|
+
result = api_instance.post_analytics_conversations_aggregates_query(body)
|
|
3662
|
+
p result
|
|
3663
|
+
rescue PureCloud::ApiError => e
|
|
3664
|
+
puts "Exception when calling ConversationsApi->post_analytics_conversations_aggregates_query: #{e}"
|
|
3665
|
+
end
|
|
3666
|
+
~~~
|
|
3667
|
+
|
|
3668
|
+
### Parameters
|
|
3669
|
+
|
|
3670
|
+
Name | Type | Description | Notes
|
|
3671
|
+
------------- | ------------- | ------------- | -------------
|
|
3672
|
+
**body** | [**AggregationQuery**](AggregationQuery.html)| query |
|
|
3673
|
+
{: class="table table-striped"}
|
|
3674
|
+
|
|
3675
|
+
|
|
3676
|
+
### Return type
|
|
3677
|
+
|
|
3678
|
+
[**AggregateQueryResponse**](AggregateQueryResponse.html)
|
|
3679
|
+
|
|
3680
|
+
### HTTP request headers
|
|
3681
|
+
|
|
3682
|
+
- **Content-Type**: application/json
|
|
3683
|
+
- **Accept**: application/json
|
|
3684
|
+
|
|
3685
|
+
|
|
3686
|
+
|
|
3687
|
+
<a name="post_analytics_conversations_details_query"></a>
|
|
3688
|
+
|
|
3689
|
+
## -[**AnalyticsConversationQueryResponse**](AnalyticsConversationQueryResponse.html) post_analytics_conversations_details_query(body)
|
|
3690
|
+
|
|
3691
|
+
Query for conversation details
|
|
3692
|
+
|
|
3693
|
+
|
|
3694
|
+
|
|
3695
|
+
Wraps POST /api/v2/analytics/conversations/details/query
|
|
3696
|
+
|
|
3697
|
+
|
|
3698
|
+
### Example
|
|
3699
|
+
~~~ruby
|
|
3700
|
+
# load the gem
|
|
3701
|
+
require 'purecloudplatformclientv2'
|
|
3702
|
+
# setup authorization
|
|
3703
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
3704
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
3705
|
+
environment = "mypurecloud.com"
|
|
3706
|
+
|
|
3707
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
3708
|
+
|
|
3709
|
+
PureCloud.configure do |config|
|
|
3710
|
+
config.access_token = @authToken
|
|
3711
|
+
end
|
|
3712
|
+
|
|
3713
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
3714
|
+
|
|
3715
|
+
body = PureCloud::ConversationQuery.new # ConversationQuery | query
|
|
3716
|
+
|
|
3717
|
+
|
|
3718
|
+
begin
|
|
3719
|
+
#Query for conversation details
|
|
3720
|
+
result = api_instance.post_analytics_conversations_details_query(body)
|
|
3721
|
+
p result
|
|
3722
|
+
rescue PureCloud::ApiError => e
|
|
3723
|
+
puts "Exception when calling ConversationsApi->post_analytics_conversations_details_query: #{e}"
|
|
3724
|
+
end
|
|
3725
|
+
~~~
|
|
3726
|
+
|
|
3727
|
+
### Parameters
|
|
3728
|
+
|
|
3729
|
+
Name | Type | Description | Notes
|
|
3730
|
+
------------- | ------------- | ------------- | -------------
|
|
3731
|
+
**body** | [**ConversationQuery**](ConversationQuery.html)| query |
|
|
3732
|
+
{: class="table table-striped"}
|
|
3733
|
+
|
|
3734
|
+
|
|
3735
|
+
### Return type
|
|
3736
|
+
|
|
3737
|
+
[**AnalyticsConversationQueryResponse**](AnalyticsConversationQueryResponse.html)
|
|
3738
|
+
|
|
3739
|
+
### HTTP request headers
|
|
3740
|
+
|
|
3741
|
+
- **Content-Type**: application/json
|
|
3742
|
+
- **Accept**: application/json
|
|
3743
|
+
|
|
3744
|
+
|
|
3745
|
+
|
|
3746
|
+
<a name="post_conversation_participant_callbacks"></a>
|
|
3747
|
+
|
|
3748
|
+
## - post_conversation_participant_callbacks(conversation_id, participant_id, opts)
|
|
3749
|
+
|
|
3750
|
+
Create a new callback for the specified participant on the conversation.
|
|
3751
|
+
|
|
3752
|
+
|
|
3753
|
+
|
|
3754
|
+
Wraps POST /api/v2/conversations/{conversationId}/participants/{participantId}/callbacks
|
|
3755
|
+
|
|
3756
|
+
|
|
3757
|
+
### Example
|
|
3758
|
+
~~~ruby
|
|
3759
|
+
# load the gem
|
|
3760
|
+
require 'purecloudplatformclientv2'
|
|
3761
|
+
# setup authorization
|
|
3762
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
3763
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
3764
|
+
environment = "mypurecloud.com"
|
|
3765
|
+
|
|
3766
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
3767
|
+
|
|
3768
|
+
PureCloud.configure do |config|
|
|
3769
|
+
config.access_token = @authToken
|
|
3770
|
+
end
|
|
3771
|
+
|
|
3772
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
3773
|
+
|
|
3774
|
+
conversation_id = "conversation_id_example" # String | conversation ID
|
|
3775
|
+
|
|
3776
|
+
participant_id = "participant_id_example" # String | participant ID
|
|
3777
|
+
|
|
3778
|
+
opts = {
|
|
3779
|
+
body: PureCloud::CreateCallbackCommand.new # CreateCallbackCommand |
|
|
3780
|
+
}
|
|
3781
|
+
|
|
3782
|
+
begin
|
|
3783
|
+
#Create a new callback for the specified participant on the conversation.
|
|
3784
|
+
api_instance.post_conversation_participant_callbacks(conversation_id, participant_id, opts)
|
|
3785
|
+
rescue PureCloud::ApiError => e
|
|
3786
|
+
puts "Exception when calling ConversationsApi->post_conversation_participant_callbacks: #{e}"
|
|
3787
|
+
end
|
|
3788
|
+
~~~
|
|
3789
|
+
|
|
3790
|
+
### Parameters
|
|
3791
|
+
|
|
3792
|
+
Name | Type | Description | Notes
|
|
3793
|
+
------------- | ------------- | ------------- | -------------
|
|
3794
|
+
**conversation_id** | **String**| conversation ID |
|
|
3795
|
+
**participant_id** | **String**| participant ID |
|
|
3796
|
+
**body** | [**CreateCallbackCommand**](CreateCallbackCommand.html)| | [optional]
|
|
3797
|
+
{: class="table table-striped"}
|
|
3798
|
+
|
|
3799
|
+
|
|
3800
|
+
### Return type
|
|
3801
|
+
|
|
3802
|
+
nil (empty response body)
|
|
3803
|
+
|
|
3804
|
+
### HTTP request headers
|
|
3805
|
+
|
|
3806
|
+
- **Content-Type**: application/json
|
|
3807
|
+
- **Accept**: application/json
|
|
3808
|
+
|
|
3809
|
+
|
|
3810
|
+
|
|
3811
|
+
<a name="post_conversation_participant_replace"></a>
|
|
3812
|
+
|
|
3813
|
+
## - post_conversation_participant_replace(conversation_id, participant_id, body)
|
|
3814
|
+
|
|
3815
|
+
Replace this participant with the specified user and/or address
|
|
3816
|
+
|
|
3817
|
+
|
|
3818
|
+
|
|
3819
|
+
Wraps POST /api/v2/conversations/{conversationId}/participants/{participantId}/replace
|
|
3820
|
+
|
|
3821
|
+
|
|
3822
|
+
### Example
|
|
3823
|
+
~~~ruby
|
|
3824
|
+
# load the gem
|
|
3825
|
+
require 'purecloudplatformclientv2'
|
|
3826
|
+
# setup authorization
|
|
3827
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
3828
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
3829
|
+
environment = "mypurecloud.com"
|
|
3830
|
+
|
|
3831
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
3832
|
+
|
|
3833
|
+
PureCloud.configure do |config|
|
|
3834
|
+
config.access_token = @authToken
|
|
3835
|
+
end
|
|
3836
|
+
|
|
3837
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
3838
|
+
|
|
3839
|
+
conversation_id = "conversation_id_example" # String | conversation ID
|
|
3840
|
+
|
|
3841
|
+
participant_id = "participant_id_example" # String | participant ID
|
|
3842
|
+
|
|
3843
|
+
body = PureCloud::TransferRequest.new # TransferRequest | Transfer request
|
|
3844
|
+
|
|
3845
|
+
|
|
3846
|
+
begin
|
|
3847
|
+
#Replace this participant with the specified user and/or address
|
|
3848
|
+
api_instance.post_conversation_participant_replace(conversation_id, participant_id, body)
|
|
3849
|
+
rescue PureCloud::ApiError => e
|
|
3850
|
+
puts "Exception when calling ConversationsApi->post_conversation_participant_replace: #{e}"
|
|
3851
|
+
end
|
|
3852
|
+
~~~
|
|
3853
|
+
|
|
3854
|
+
### Parameters
|
|
3855
|
+
|
|
3856
|
+
Name | Type | Description | Notes
|
|
3857
|
+
------------- | ------------- | ------------- | -------------
|
|
3858
|
+
**conversation_id** | **String**| conversation ID |
|
|
3859
|
+
**participant_id** | **String**| participant ID |
|
|
3860
|
+
**body** | [**TransferRequest**](TransferRequest.html)| Transfer request |
|
|
3861
|
+
{: class="table table-striped"}
|
|
3862
|
+
|
|
3863
|
+
|
|
3864
|
+
### Return type
|
|
3865
|
+
|
|
3866
|
+
nil (empty response body)
|
|
3867
|
+
|
|
3868
|
+
### HTTP request headers
|
|
3869
|
+
|
|
3870
|
+
- **Content-Type**: application/json
|
|
3871
|
+
- **Accept**: application/json
|
|
3872
|
+
|
|
3873
|
+
|
|
3874
|
+
|
|
3875
|
+
<a name="post_conversations_call"></a>
|
|
3876
|
+
|
|
3877
|
+
## -[**Conversation**](Conversation.html) post_conversations_call(call_id, body)
|
|
3878
|
+
|
|
3879
|
+
Add a new call to a conversation
|
|
3880
|
+
|
|
3881
|
+
|
|
3882
|
+
|
|
3883
|
+
Wraps POST /api/v2/conversations/calls/{callId}
|
|
3884
|
+
|
|
3885
|
+
|
|
3886
|
+
### Example
|
|
3887
|
+
~~~ruby
|
|
3888
|
+
# load the gem
|
|
3889
|
+
require 'purecloudplatformclientv2'
|
|
3890
|
+
# setup authorization
|
|
3891
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
3892
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
3893
|
+
environment = "mypurecloud.com"
|
|
3894
|
+
|
|
3895
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
3896
|
+
|
|
3897
|
+
PureCloud.configure do |config|
|
|
3898
|
+
config.access_token = @authToken
|
|
3899
|
+
end
|
|
3900
|
+
|
|
3901
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
3902
|
+
|
|
3903
|
+
call_id = "call_id_example" # String | callId
|
|
3904
|
+
|
|
3905
|
+
body = PureCloud::CallCommand.new # CallCommand | Conversation
|
|
3906
|
+
|
|
3907
|
+
|
|
3908
|
+
begin
|
|
3909
|
+
#Add a new call to a conversation
|
|
3910
|
+
result = api_instance.post_conversations_call(call_id, body)
|
|
3911
|
+
p result
|
|
3912
|
+
rescue PureCloud::ApiError => e
|
|
3913
|
+
puts "Exception when calling ConversationsApi->post_conversations_call: #{e}"
|
|
3914
|
+
end
|
|
3915
|
+
~~~
|
|
3916
|
+
|
|
3917
|
+
### Parameters
|
|
3918
|
+
|
|
3919
|
+
Name | Type | Description | Notes
|
|
3920
|
+
------------- | ------------- | ------------- | -------------
|
|
3921
|
+
**call_id** | **String**| callId |
|
|
3922
|
+
**body** | [**CallCommand**](CallCommand.html)| Conversation |
|
|
3923
|
+
{: class="table table-striped"}
|
|
3924
|
+
|
|
3925
|
+
|
|
3926
|
+
### Return type
|
|
3927
|
+
|
|
3928
|
+
[**Conversation**](Conversation.html)
|
|
3929
|
+
|
|
3930
|
+
### HTTP request headers
|
|
3931
|
+
|
|
3932
|
+
- **Content-Type**: application/json
|
|
3933
|
+
- **Accept**: application/json
|
|
3934
|
+
|
|
3935
|
+
|
|
3936
|
+
|
|
3937
|
+
<a name="post_conversations_call_participant_consult"></a>
|
|
3938
|
+
|
|
3939
|
+
## -[**ConsultTransferResponse**](ConsultTransferResponse.html) post_conversations_call_participant_consult(call_id, participant_id, body)
|
|
3940
|
+
|
|
3941
|
+
Initiate and update consult transfer
|
|
3942
|
+
|
|
3943
|
+
|
|
3944
|
+
|
|
3945
|
+
Wraps POST /api/v2/conversations/calls/{callId}/participants/{participantId}/consult
|
|
3946
|
+
|
|
3947
|
+
|
|
3948
|
+
### Example
|
|
3949
|
+
~~~ruby
|
|
3950
|
+
# load the gem
|
|
3951
|
+
require 'purecloudplatformclientv2'
|
|
3952
|
+
# setup authorization
|
|
3953
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
3954
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
3955
|
+
environment = "mypurecloud.com"
|
|
3956
|
+
|
|
3957
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
3958
|
+
|
|
3959
|
+
PureCloud.configure do |config|
|
|
3960
|
+
config.access_token = @authToken
|
|
3961
|
+
end
|
|
3962
|
+
|
|
3963
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
3964
|
+
|
|
3965
|
+
call_id = "call_id_example" # String | callId
|
|
3966
|
+
|
|
3967
|
+
participant_id = "participant_id_example" # String | participantId
|
|
3968
|
+
|
|
3969
|
+
body = PureCloud::ConsultTransfer.new # ConsultTransfer | Destination address & initial speak to
|
|
3970
|
+
|
|
3971
|
+
|
|
3972
|
+
begin
|
|
3973
|
+
#Initiate and update consult transfer
|
|
3974
|
+
result = api_instance.post_conversations_call_participant_consult(call_id, participant_id, body)
|
|
3975
|
+
p result
|
|
3976
|
+
rescue PureCloud::ApiError => e
|
|
3977
|
+
puts "Exception when calling ConversationsApi->post_conversations_call_participant_consult: #{e}"
|
|
3978
|
+
end
|
|
3979
|
+
~~~
|
|
3980
|
+
|
|
3981
|
+
### Parameters
|
|
3982
|
+
|
|
3983
|
+
Name | Type | Description | Notes
|
|
3984
|
+
------------- | ------------- | ------------- | -------------
|
|
3985
|
+
**call_id** | **String**| callId |
|
|
3986
|
+
**participant_id** | **String**| participantId |
|
|
3987
|
+
**body** | [**ConsultTransfer**](ConsultTransfer.html)| Destination address & initial speak to |
|
|
3988
|
+
{: class="table table-striped"}
|
|
3989
|
+
|
|
3990
|
+
|
|
3991
|
+
### Return type
|
|
3992
|
+
|
|
3993
|
+
[**ConsultTransferResponse**](ConsultTransferResponse.html)
|
|
3994
|
+
|
|
3995
|
+
### HTTP request headers
|
|
3996
|
+
|
|
3997
|
+
- **Content-Type**: application/json
|
|
3998
|
+
- **Accept**: application/json
|
|
3999
|
+
|
|
4000
|
+
|
|
4001
|
+
|
|
4002
|
+
<a name="post_conversations_call_participant_monitor"></a>
|
|
4003
|
+
|
|
4004
|
+
## - post_conversations_call_participant_monitor(call_id, participant_id)
|
|
4005
|
+
|
|
4006
|
+
Listen in on the conversation from the point of view of a given participant.
|
|
4007
|
+
|
|
4008
|
+
|
|
4009
|
+
|
|
4010
|
+
Wraps POST /api/v2/conversations/calls/{callId}/participants/{participantId}/monitor
|
|
4011
|
+
|
|
4012
|
+
|
|
4013
|
+
### Example
|
|
4014
|
+
~~~ruby
|
|
4015
|
+
# load the gem
|
|
4016
|
+
require 'purecloudplatformclientv2'
|
|
4017
|
+
# setup authorization
|
|
4018
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
4019
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
4020
|
+
environment = "mypurecloud.com"
|
|
4021
|
+
|
|
4022
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
4023
|
+
|
|
4024
|
+
PureCloud.configure do |config|
|
|
4025
|
+
config.access_token = @authToken
|
|
4026
|
+
end
|
|
4027
|
+
|
|
4028
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
4029
|
+
|
|
4030
|
+
call_id = "call_id_example" # String | callId
|
|
4031
|
+
|
|
4032
|
+
participant_id = "participant_id_example" # String | participantId
|
|
4033
|
+
|
|
4034
|
+
|
|
4035
|
+
begin
|
|
4036
|
+
#Listen in on the conversation from the point of view of a given participant.
|
|
4037
|
+
api_instance.post_conversations_call_participant_monitor(call_id, participant_id)
|
|
4038
|
+
rescue PureCloud::ApiError => e
|
|
4039
|
+
puts "Exception when calling ConversationsApi->post_conversations_call_participant_monitor: #{e}"
|
|
4040
|
+
end
|
|
4041
|
+
~~~
|
|
4042
|
+
|
|
4043
|
+
### Parameters
|
|
4044
|
+
|
|
4045
|
+
Name | Type | Description | Notes
|
|
4046
|
+
------------- | ------------- | ------------- | -------------
|
|
4047
|
+
**call_id** | **String**| callId |
|
|
4048
|
+
**participant_id** | **String**| participantId |
|
|
4049
|
+
{: class="table table-striped"}
|
|
4050
|
+
|
|
4051
|
+
|
|
4052
|
+
### Return type
|
|
4053
|
+
|
|
4054
|
+
nil (empty response body)
|
|
4055
|
+
|
|
4056
|
+
### HTTP request headers
|
|
4057
|
+
|
|
4058
|
+
- **Content-Type**: application/json
|
|
4059
|
+
- **Accept**: application/json
|
|
4060
|
+
|
|
4061
|
+
|
|
4062
|
+
|
|
4063
|
+
<a name="post_conversations_call_participant_replace"></a>
|
|
4064
|
+
|
|
4065
|
+
## - post_conversations_call_participant_replace(call_id, participant_id, body)
|
|
4066
|
+
|
|
4067
|
+
Replace this participant with the specified user and/or address
|
|
4068
|
+
|
|
4069
|
+
|
|
4070
|
+
|
|
4071
|
+
Wraps POST /api/v2/conversations/calls/{callId}/participants/{participantId}/replace
|
|
4072
|
+
|
|
4073
|
+
|
|
4074
|
+
### Example
|
|
4075
|
+
~~~ruby
|
|
4076
|
+
# load the gem
|
|
4077
|
+
require 'purecloudplatformclientv2'
|
|
4078
|
+
# setup authorization
|
|
4079
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
4080
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
4081
|
+
environment = "mypurecloud.com"
|
|
4082
|
+
|
|
4083
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
4084
|
+
|
|
4085
|
+
PureCloud.configure do |config|
|
|
4086
|
+
config.access_token = @authToken
|
|
4087
|
+
end
|
|
4088
|
+
|
|
4089
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
4090
|
+
|
|
4091
|
+
call_id = "call_id_example" # String | callId
|
|
4092
|
+
|
|
4093
|
+
participant_id = "participant_id_example" # String | participantId
|
|
4094
|
+
|
|
4095
|
+
body = PureCloud::TransferRequest.new # TransferRequest | Transfer request
|
|
4096
|
+
|
|
4097
|
+
|
|
4098
|
+
begin
|
|
4099
|
+
#Replace this participant with the specified user and/or address
|
|
4100
|
+
api_instance.post_conversations_call_participant_replace(call_id, participant_id, body)
|
|
4101
|
+
rescue PureCloud::ApiError => e
|
|
4102
|
+
puts "Exception when calling ConversationsApi->post_conversations_call_participant_replace: #{e}"
|
|
4103
|
+
end
|
|
4104
|
+
~~~
|
|
4105
|
+
|
|
4106
|
+
### Parameters
|
|
4107
|
+
|
|
4108
|
+
Name | Type | Description | Notes
|
|
4109
|
+
------------- | ------------- | ------------- | -------------
|
|
4110
|
+
**call_id** | **String**| callId |
|
|
4111
|
+
**participant_id** | **String**| participantId |
|
|
4112
|
+
**body** | [**TransferRequest**](TransferRequest.html)| Transfer request |
|
|
4113
|
+
{: class="table table-striped"}
|
|
4114
|
+
|
|
4115
|
+
|
|
4116
|
+
### Return type
|
|
4117
|
+
|
|
4118
|
+
nil (empty response body)
|
|
4119
|
+
|
|
4120
|
+
### HTTP request headers
|
|
4121
|
+
|
|
4122
|
+
- **Content-Type**: application/json
|
|
4123
|
+
- **Accept**: application/json
|
|
4124
|
+
|
|
4125
|
+
|
|
4126
|
+
|
|
4127
|
+
<a name="post_conversations_call_participants"></a>
|
|
4128
|
+
|
|
4129
|
+
## -[**Conversation**](Conversation.html) post_conversations_call_participants(call_id, body)
|
|
4130
|
+
|
|
4131
|
+
Add participants to a conversation
|
|
4132
|
+
|
|
4133
|
+
|
|
4134
|
+
|
|
4135
|
+
Wraps POST /api/v2/conversations/calls/{callId}/participants
|
|
4136
|
+
|
|
4137
|
+
|
|
4138
|
+
### Example
|
|
4139
|
+
~~~ruby
|
|
4140
|
+
# load the gem
|
|
4141
|
+
require 'purecloudplatformclientv2'
|
|
4142
|
+
# setup authorization
|
|
4143
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
4144
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
4145
|
+
environment = "mypurecloud.com"
|
|
4146
|
+
|
|
4147
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
4148
|
+
|
|
4149
|
+
PureCloud.configure do |config|
|
|
4150
|
+
config.access_token = @authToken
|
|
4151
|
+
end
|
|
4152
|
+
|
|
4153
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
4154
|
+
|
|
4155
|
+
call_id = "call_id_example" # String | callId
|
|
4156
|
+
|
|
4157
|
+
body = PureCloud::Conversation.new # Conversation | Conversation
|
|
4158
|
+
|
|
4159
|
+
|
|
4160
|
+
begin
|
|
4161
|
+
#Add participants to a conversation
|
|
4162
|
+
result = api_instance.post_conversations_call_participants(call_id, body)
|
|
4163
|
+
p result
|
|
4164
|
+
rescue PureCloud::ApiError => e
|
|
4165
|
+
puts "Exception when calling ConversationsApi->post_conversations_call_participants: #{e}"
|
|
4166
|
+
end
|
|
4167
|
+
~~~
|
|
4168
|
+
|
|
4169
|
+
### Parameters
|
|
4170
|
+
|
|
4171
|
+
Name | Type | Description | Notes
|
|
4172
|
+
------------- | ------------- | ------------- | -------------
|
|
4173
|
+
**call_id** | **String**| callId |
|
|
4174
|
+
**body** | [**Conversation**](Conversation.html)| Conversation |
|
|
4175
|
+
{: class="table table-striped"}
|
|
4176
|
+
|
|
4177
|
+
|
|
4178
|
+
### Return type
|
|
4179
|
+
|
|
4180
|
+
[**Conversation**](Conversation.html)
|
|
4181
|
+
|
|
4182
|
+
### HTTP request headers
|
|
4183
|
+
|
|
4184
|
+
- **Content-Type**: application/json
|
|
4185
|
+
- **Accept**: application/json
|
|
4186
|
+
|
|
4187
|
+
|
|
4188
|
+
|
|
4189
|
+
<a name="post_conversations_callback_participant_replace"></a>
|
|
4190
|
+
|
|
4191
|
+
## - post_conversations_callback_participant_replace(callback_id, participant_id, body)
|
|
4192
|
+
|
|
4193
|
+
Replace this participant with the specified user and/or address
|
|
4194
|
+
|
|
4195
|
+
|
|
4196
|
+
|
|
4197
|
+
Wraps POST /api/v2/conversations/callbacks/{callbackId}/participants/{participantId}/replace
|
|
4198
|
+
|
|
4199
|
+
|
|
4200
|
+
### Example
|
|
4201
|
+
~~~ruby
|
|
4202
|
+
# load the gem
|
|
4203
|
+
require 'purecloudplatformclientv2'
|
|
4204
|
+
# setup authorization
|
|
4205
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
4206
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
4207
|
+
environment = "mypurecloud.com"
|
|
4208
|
+
|
|
4209
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
4210
|
+
|
|
4211
|
+
PureCloud.configure do |config|
|
|
4212
|
+
config.access_token = @authToken
|
|
4213
|
+
end
|
|
4214
|
+
|
|
4215
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
4216
|
+
|
|
4217
|
+
callback_id = "callback_id_example" # String | callbackId
|
|
4218
|
+
|
|
4219
|
+
participant_id = "participant_id_example" # String | participantId
|
|
4220
|
+
|
|
4221
|
+
body = PureCloud::TransferRequest.new # TransferRequest | Transfer request
|
|
4222
|
+
|
|
4223
|
+
|
|
4224
|
+
begin
|
|
4225
|
+
#Replace this participant with the specified user and/or address
|
|
4226
|
+
api_instance.post_conversations_callback_participant_replace(callback_id, participant_id, body)
|
|
4227
|
+
rescue PureCloud::ApiError => e
|
|
4228
|
+
puts "Exception when calling ConversationsApi->post_conversations_callback_participant_replace: #{e}"
|
|
4229
|
+
end
|
|
4230
|
+
~~~
|
|
4231
|
+
|
|
4232
|
+
### Parameters
|
|
4233
|
+
|
|
4234
|
+
Name | Type | Description | Notes
|
|
4235
|
+
------------- | ------------- | ------------- | -------------
|
|
4236
|
+
**callback_id** | **String**| callbackId |
|
|
4237
|
+
**participant_id** | **String**| participantId |
|
|
4238
|
+
**body** | [**TransferRequest**](TransferRequest.html)| Transfer request |
|
|
4239
|
+
{: class="table table-striped"}
|
|
4240
|
+
|
|
4241
|
+
|
|
4242
|
+
### Return type
|
|
4243
|
+
|
|
4244
|
+
nil (empty response body)
|
|
4245
|
+
|
|
4246
|
+
### HTTP request headers
|
|
4247
|
+
|
|
4248
|
+
- **Content-Type**: application/json
|
|
4249
|
+
- **Accept**: application/json
|
|
4250
|
+
|
|
4251
|
+
|
|
4252
|
+
|
|
4253
|
+
<a name="post_conversations_callbacks"></a>
|
|
4254
|
+
|
|
4255
|
+
## -[**CreateCallbackResponse**](CreateCallbackResponse.html) post_conversations_callbacks(body)
|
|
4256
|
+
|
|
4257
|
+
Create a Callback
|
|
4258
|
+
|
|
4259
|
+
|
|
4260
|
+
|
|
4261
|
+
Wraps POST /api/v2/conversations/callbacks
|
|
4262
|
+
|
|
4263
|
+
|
|
4264
|
+
### Example
|
|
4265
|
+
~~~ruby
|
|
4266
|
+
# load the gem
|
|
4267
|
+
require 'purecloudplatformclientv2'
|
|
4268
|
+
# setup authorization
|
|
4269
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
4270
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
4271
|
+
environment = "mypurecloud.com"
|
|
4272
|
+
|
|
4273
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
4274
|
+
|
|
4275
|
+
PureCloud.configure do |config|
|
|
4276
|
+
config.access_token = @authToken
|
|
4277
|
+
end
|
|
4278
|
+
|
|
4279
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
4280
|
+
|
|
4281
|
+
body = PureCloud::CreateCallbackCommand.new # CreateCallbackCommand | Callback
|
|
4282
|
+
|
|
4283
|
+
|
|
4284
|
+
begin
|
|
4285
|
+
#Create a Callback
|
|
4286
|
+
result = api_instance.post_conversations_callbacks(body)
|
|
4287
|
+
p result
|
|
4288
|
+
rescue PureCloud::ApiError => e
|
|
4289
|
+
puts "Exception when calling ConversationsApi->post_conversations_callbacks: #{e}"
|
|
4290
|
+
end
|
|
4291
|
+
~~~
|
|
4292
|
+
|
|
4293
|
+
### Parameters
|
|
4294
|
+
|
|
4295
|
+
Name | Type | Description | Notes
|
|
4296
|
+
------------- | ------------- | ------------- | -------------
|
|
4297
|
+
**body** | [**CreateCallbackCommand**](CreateCallbackCommand.html)| Callback |
|
|
4298
|
+
{: class="table table-striped"}
|
|
4299
|
+
|
|
4300
|
+
|
|
4301
|
+
### Return type
|
|
4302
|
+
|
|
4303
|
+
[**CreateCallbackResponse**](CreateCallbackResponse.html)
|
|
4304
|
+
|
|
4305
|
+
### HTTP request headers
|
|
4306
|
+
|
|
4307
|
+
- **Content-Type**: application/json
|
|
4308
|
+
- **Accept**: application/json
|
|
4309
|
+
|
|
4310
|
+
|
|
4311
|
+
|
|
4312
|
+
<a name="post_conversations_calls"></a>
|
|
4313
|
+
|
|
4314
|
+
## -[**CreateCallResponse**](CreateCallResponse.html) post_conversations_calls(body)
|
|
4315
|
+
|
|
4316
|
+
Create a call conversation
|
|
4317
|
+
|
|
4318
|
+
|
|
4319
|
+
|
|
4320
|
+
Wraps POST /api/v2/conversations/calls
|
|
4321
|
+
|
|
4322
|
+
|
|
4323
|
+
### Example
|
|
4324
|
+
~~~ruby
|
|
4325
|
+
# load the gem
|
|
4326
|
+
require 'purecloudplatformclientv2'
|
|
4327
|
+
# setup authorization
|
|
4328
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
4329
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
4330
|
+
environment = "mypurecloud.com"
|
|
4331
|
+
|
|
4332
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
4333
|
+
|
|
4334
|
+
PureCloud.configure do |config|
|
|
4335
|
+
config.access_token = @authToken
|
|
4336
|
+
end
|
|
4337
|
+
|
|
4338
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
4339
|
+
|
|
4340
|
+
body = PureCloud::CreateCallRequest.new # CreateCallRequest | Call request
|
|
4341
|
+
|
|
4342
|
+
|
|
4343
|
+
begin
|
|
4344
|
+
#Create a call conversation
|
|
4345
|
+
result = api_instance.post_conversations_calls(body)
|
|
4346
|
+
p result
|
|
4347
|
+
rescue PureCloud::ApiError => e
|
|
4348
|
+
puts "Exception when calling ConversationsApi->post_conversations_calls: #{e}"
|
|
4349
|
+
end
|
|
4350
|
+
~~~
|
|
4351
|
+
|
|
4352
|
+
### Parameters
|
|
4353
|
+
|
|
4354
|
+
Name | Type | Description | Notes
|
|
4355
|
+
------------- | ------------- | ------------- | -------------
|
|
4356
|
+
**body** | [**CreateCallRequest**](CreateCallRequest.html)| Call request |
|
|
4357
|
+
{: class="table table-striped"}
|
|
4358
|
+
|
|
4359
|
+
|
|
4360
|
+
### Return type
|
|
4361
|
+
|
|
4362
|
+
[**CreateCallResponse**](CreateCallResponse.html)
|
|
4363
|
+
|
|
4364
|
+
### HTTP request headers
|
|
4365
|
+
|
|
4366
|
+
- **Content-Type**: application/json
|
|
4367
|
+
- **Accept**: application/json
|
|
4368
|
+
|
|
4369
|
+
|
|
4370
|
+
|
|
4371
|
+
<a name="post_conversations_chat_participant_replace"></a>
|
|
4372
|
+
|
|
4373
|
+
## - post_conversations_chat_participant_replace(chat_id, participant_id, body)
|
|
4374
|
+
|
|
4375
|
+
Replace this participant with the specified user and/or address
|
|
4376
|
+
|
|
4377
|
+
|
|
4378
|
+
|
|
4379
|
+
Wraps POST /api/v2/conversations/chats/{chatId}/participants/{participantId}/replace
|
|
4380
|
+
|
|
4381
|
+
|
|
4382
|
+
### Example
|
|
4383
|
+
~~~ruby
|
|
4384
|
+
# load the gem
|
|
4385
|
+
require 'purecloudplatformclientv2'
|
|
4386
|
+
# setup authorization
|
|
4387
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
4388
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
4389
|
+
environment = "mypurecloud.com"
|
|
4390
|
+
|
|
4391
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
4392
|
+
|
|
4393
|
+
PureCloud.configure do |config|
|
|
4394
|
+
config.access_token = @authToken
|
|
4395
|
+
end
|
|
4396
|
+
|
|
4397
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
4398
|
+
|
|
4399
|
+
chat_id = "chat_id_example" # String | chatId
|
|
4400
|
+
|
|
4401
|
+
participant_id = "participant_id_example" # String | participantId
|
|
4402
|
+
|
|
4403
|
+
body = PureCloud::TransferRequest.new # TransferRequest | Transfer request
|
|
4404
|
+
|
|
4405
|
+
|
|
4406
|
+
begin
|
|
4407
|
+
#Replace this participant with the specified user and/or address
|
|
4408
|
+
api_instance.post_conversations_chat_participant_replace(chat_id, participant_id, body)
|
|
4409
|
+
rescue PureCloud::ApiError => e
|
|
4410
|
+
puts "Exception when calling ConversationsApi->post_conversations_chat_participant_replace: #{e}"
|
|
4411
|
+
end
|
|
4412
|
+
~~~
|
|
4413
|
+
|
|
4414
|
+
### Parameters
|
|
4415
|
+
|
|
4416
|
+
Name | Type | Description | Notes
|
|
4417
|
+
------------- | ------------- | ------------- | -------------
|
|
4418
|
+
**chat_id** | **String**| chatId |
|
|
4419
|
+
**participant_id** | **String**| participantId |
|
|
4420
|
+
**body** | [**TransferRequest**](TransferRequest.html)| Transfer request |
|
|
4421
|
+
{: class="table table-striped"}
|
|
4422
|
+
|
|
4423
|
+
|
|
4424
|
+
### Return type
|
|
4425
|
+
|
|
4426
|
+
nil (empty response body)
|
|
4427
|
+
|
|
4428
|
+
### HTTP request headers
|
|
4429
|
+
|
|
4430
|
+
- **Content-Type**: application/json
|
|
4431
|
+
- **Accept**: application/json
|
|
4432
|
+
|
|
4433
|
+
|
|
4434
|
+
|
|
4435
|
+
<a name="post_conversations_chats"></a>
|
|
4436
|
+
|
|
4437
|
+
## -[**ChatConversation**](ChatConversation.html) post_conversations_chats(body)
|
|
4438
|
+
|
|
4439
|
+
Create a web chat conversation
|
|
4440
|
+
|
|
4441
|
+
|
|
4442
|
+
|
|
4443
|
+
Wraps POST /api/v2/conversations/chats
|
|
4444
|
+
|
|
4445
|
+
|
|
4446
|
+
### Example
|
|
4447
|
+
~~~ruby
|
|
4448
|
+
# load the gem
|
|
4449
|
+
require 'purecloudplatformclientv2'
|
|
4450
|
+
# setup authorization
|
|
4451
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
4452
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
4453
|
+
environment = "mypurecloud.com"
|
|
4454
|
+
|
|
4455
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
4456
|
+
|
|
4457
|
+
PureCloud.configure do |config|
|
|
4458
|
+
config.access_token = @authToken
|
|
4459
|
+
end
|
|
4460
|
+
|
|
4461
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
4462
|
+
|
|
4463
|
+
body = PureCloud::CreateWebChatRequest.new # CreateWebChatRequest | Create web chat request
|
|
4464
|
+
|
|
4465
|
+
|
|
4466
|
+
begin
|
|
4467
|
+
#Create a web chat conversation
|
|
4468
|
+
result = api_instance.post_conversations_chats(body)
|
|
4469
|
+
p result
|
|
4470
|
+
rescue PureCloud::ApiError => e
|
|
4471
|
+
puts "Exception when calling ConversationsApi->post_conversations_chats: #{e}"
|
|
4472
|
+
end
|
|
4473
|
+
~~~
|
|
4474
|
+
|
|
4475
|
+
### Parameters
|
|
4476
|
+
|
|
4477
|
+
Name | Type | Description | Notes
|
|
4478
|
+
------------- | ------------- | ------------- | -------------
|
|
4479
|
+
**body** | [**CreateWebChatRequest**](CreateWebChatRequest.html)| Create web chat request |
|
|
4480
|
+
{: class="table table-striped"}
|
|
4481
|
+
|
|
4482
|
+
|
|
4483
|
+
### Return type
|
|
4484
|
+
|
|
4485
|
+
[**ChatConversation**](ChatConversation.html)
|
|
4486
|
+
|
|
4487
|
+
### HTTP request headers
|
|
4488
|
+
|
|
4489
|
+
- **Content-Type**: application/json
|
|
4490
|
+
- **Accept**: application/json
|
|
4491
|
+
|
|
4492
|
+
|
|
4493
|
+
|
|
4494
|
+
<a name="post_conversations_cobrowsesession_participant_replace"></a>
|
|
4495
|
+
|
|
4496
|
+
## - post_conversations_cobrowsesession_participant_replace(cobrowse_id, participant_id, opts)
|
|
4497
|
+
|
|
4498
|
+
Replace this participant with the specified user and/or address
|
|
4499
|
+
|
|
4500
|
+
|
|
4501
|
+
|
|
4502
|
+
Wraps POST /api/v2/conversations/cobrowsesessions/{cobrowseId}/participants/{participantId}/replace
|
|
4503
|
+
|
|
4504
|
+
|
|
4505
|
+
### Example
|
|
4506
|
+
~~~ruby
|
|
4507
|
+
# load the gem
|
|
4508
|
+
require 'purecloudplatformclientv2'
|
|
4509
|
+
# setup authorization
|
|
4510
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
4511
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
4512
|
+
environment = "mypurecloud.com"
|
|
4513
|
+
|
|
4514
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
4515
|
+
|
|
4516
|
+
PureCloud.configure do |config|
|
|
4517
|
+
config.access_token = @authToken
|
|
4518
|
+
end
|
|
4519
|
+
|
|
4520
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
4521
|
+
|
|
4522
|
+
cobrowse_id = "cobrowse_id_example" # String | cobrowseId
|
|
4523
|
+
|
|
4524
|
+
participant_id = "participant_id_example" # String | participantId
|
|
4525
|
+
|
|
4526
|
+
opts = {
|
|
4527
|
+
body: PureCloud::TransferRequest.new # TransferRequest |
|
|
4528
|
+
}
|
|
4529
|
+
|
|
4530
|
+
begin
|
|
4531
|
+
#Replace this participant with the specified user and/or address
|
|
4532
|
+
api_instance.post_conversations_cobrowsesession_participant_replace(cobrowse_id, participant_id, opts)
|
|
4533
|
+
rescue PureCloud::ApiError => e
|
|
4534
|
+
puts "Exception when calling ConversationsApi->post_conversations_cobrowsesession_participant_replace: #{e}"
|
|
4535
|
+
end
|
|
4536
|
+
~~~
|
|
4537
|
+
|
|
4538
|
+
### Parameters
|
|
4539
|
+
|
|
4540
|
+
Name | Type | Description | Notes
|
|
4541
|
+
------------- | ------------- | ------------- | -------------
|
|
4542
|
+
**cobrowse_id** | **String**| cobrowseId |
|
|
4543
|
+
**participant_id** | **String**| participantId |
|
|
4544
|
+
**body** | [**TransferRequest**](TransferRequest.html)| | [optional]
|
|
4545
|
+
{: class="table table-striped"}
|
|
4546
|
+
|
|
4547
|
+
|
|
4548
|
+
### Return type
|
|
4549
|
+
|
|
4550
|
+
nil (empty response body)
|
|
4551
|
+
|
|
4552
|
+
### HTTP request headers
|
|
4553
|
+
|
|
4554
|
+
- **Content-Type**: application/json
|
|
4555
|
+
- **Accept**: application/json
|
|
4556
|
+
|
|
4557
|
+
|
|
4558
|
+
|
|
4559
|
+
<a name="post_conversations_email_messages"></a>
|
|
4560
|
+
|
|
4561
|
+
## -[**EmailMessage**](EmailMessage.html) post_conversations_email_messages(email_id, body)
|
|
4562
|
+
|
|
4563
|
+
Send an email reply
|
|
4564
|
+
|
|
4565
|
+
|
|
4566
|
+
|
|
4567
|
+
Wraps POST /api/v2/conversations/emails/{emailId}/messages
|
|
4568
|
+
|
|
4569
|
+
|
|
4570
|
+
### Example
|
|
4571
|
+
~~~ruby
|
|
4572
|
+
# load the gem
|
|
4573
|
+
require 'purecloudplatformclientv2'
|
|
4574
|
+
# setup authorization
|
|
4575
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
4576
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
4577
|
+
environment = "mypurecloud.com"
|
|
4578
|
+
|
|
4579
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
4580
|
+
|
|
4581
|
+
PureCloud.configure do |config|
|
|
4582
|
+
config.access_token = @authToken
|
|
4583
|
+
end
|
|
4584
|
+
|
|
4585
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
4586
|
+
|
|
4587
|
+
email_id = "email_id_example" # String | emailId
|
|
4588
|
+
|
|
4589
|
+
body = PureCloud::EmailMessage.new # EmailMessage | Reply
|
|
4590
|
+
|
|
4591
|
+
|
|
4592
|
+
begin
|
|
4593
|
+
#Send an email reply
|
|
4594
|
+
result = api_instance.post_conversations_email_messages(email_id, body)
|
|
4595
|
+
p result
|
|
4596
|
+
rescue PureCloud::ApiError => e
|
|
4597
|
+
puts "Exception when calling ConversationsApi->post_conversations_email_messages: #{e}"
|
|
4598
|
+
end
|
|
4599
|
+
~~~
|
|
4600
|
+
|
|
4601
|
+
### Parameters
|
|
4602
|
+
|
|
4603
|
+
Name | Type | Description | Notes
|
|
4604
|
+
------------- | ------------- | ------------- | -------------
|
|
4605
|
+
**email_id** | **String**| emailId |
|
|
4606
|
+
**body** | [**EmailMessage**](EmailMessage.html)| Reply |
|
|
4607
|
+
{: class="table table-striped"}
|
|
4608
|
+
|
|
4609
|
+
|
|
4610
|
+
### Return type
|
|
4611
|
+
|
|
4612
|
+
[**EmailMessage**](EmailMessage.html)
|
|
4613
|
+
|
|
4614
|
+
### HTTP request headers
|
|
4615
|
+
|
|
4616
|
+
- **Content-Type**: application/json
|
|
4617
|
+
- **Accept**: application/json
|
|
4618
|
+
|
|
4619
|
+
|
|
4620
|
+
|
|
4621
|
+
<a name="post_conversations_email_participant_replace"></a>
|
|
4622
|
+
|
|
4623
|
+
## - post_conversations_email_participant_replace(email_id, participant_id, body)
|
|
4624
|
+
|
|
4625
|
+
Replace this participant with the specified user and/or address
|
|
4626
|
+
|
|
4627
|
+
|
|
4628
|
+
|
|
4629
|
+
Wraps POST /api/v2/conversations/emails/{emailId}/participants/{participantId}/replace
|
|
4630
|
+
|
|
4631
|
+
|
|
4632
|
+
### Example
|
|
4633
|
+
~~~ruby
|
|
4634
|
+
# load the gem
|
|
4635
|
+
require 'purecloudplatformclientv2'
|
|
4636
|
+
# setup authorization
|
|
4637
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
4638
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
4639
|
+
environment = "mypurecloud.com"
|
|
4640
|
+
|
|
4641
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
4642
|
+
|
|
4643
|
+
PureCloud.configure do |config|
|
|
4644
|
+
config.access_token = @authToken
|
|
4645
|
+
end
|
|
4646
|
+
|
|
4647
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
4648
|
+
|
|
4649
|
+
email_id = "email_id_example" # String | emailId
|
|
4650
|
+
|
|
4651
|
+
participant_id = "participant_id_example" # String | participantId
|
|
4652
|
+
|
|
4653
|
+
body = PureCloud::TransferRequest.new # TransferRequest | Transfer request
|
|
4654
|
+
|
|
4655
|
+
|
|
4656
|
+
begin
|
|
4657
|
+
#Replace this participant with the specified user and/or address
|
|
4658
|
+
api_instance.post_conversations_email_participant_replace(email_id, participant_id, body)
|
|
4659
|
+
rescue PureCloud::ApiError => e
|
|
4660
|
+
puts "Exception when calling ConversationsApi->post_conversations_email_participant_replace: #{e}"
|
|
4661
|
+
end
|
|
4662
|
+
~~~
|
|
4663
|
+
|
|
4664
|
+
### Parameters
|
|
4665
|
+
|
|
4666
|
+
Name | Type | Description | Notes
|
|
4667
|
+
------------- | ------------- | ------------- | -------------
|
|
4668
|
+
**email_id** | **String**| emailId |
|
|
4669
|
+
**participant_id** | **String**| participantId |
|
|
4670
|
+
**body** | [**TransferRequest**](TransferRequest.html)| Transfer request |
|
|
4671
|
+
{: class="table table-striped"}
|
|
4672
|
+
|
|
4673
|
+
|
|
4674
|
+
### Return type
|
|
4675
|
+
|
|
4676
|
+
nil (empty response body)
|
|
4677
|
+
|
|
4678
|
+
### HTTP request headers
|
|
4679
|
+
|
|
4680
|
+
- **Content-Type**: application/json
|
|
4681
|
+
- **Accept**: application/json
|
|
4682
|
+
|
|
4683
|
+
|
|
4684
|
+
|
|
4685
|
+
<a name="post_conversations_emails"></a>
|
|
4686
|
+
|
|
4687
|
+
## -[**EmailConversation**](EmailConversation.html) post_conversations_emails(body)
|
|
4688
|
+
|
|
4689
|
+
Create an email conversation
|
|
4690
|
+
|
|
4691
|
+
|
|
4692
|
+
|
|
4693
|
+
Wraps POST /api/v2/conversations/emails
|
|
4694
|
+
|
|
4695
|
+
|
|
4696
|
+
### Example
|
|
4697
|
+
~~~ruby
|
|
4698
|
+
# load the gem
|
|
4699
|
+
require 'purecloudplatformclientv2'
|
|
4700
|
+
# setup authorization
|
|
4701
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
4702
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
4703
|
+
environment = "mypurecloud.com"
|
|
4704
|
+
|
|
4705
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
4706
|
+
|
|
4707
|
+
PureCloud.configure do |config|
|
|
4708
|
+
config.access_token = @authToken
|
|
4709
|
+
end
|
|
4710
|
+
|
|
4711
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
4712
|
+
|
|
4713
|
+
body = PureCloud::CreateEmailRequest.new # CreateEmailRequest | Create email request
|
|
4714
|
+
|
|
4715
|
+
|
|
4716
|
+
begin
|
|
4717
|
+
#Create an email conversation
|
|
4718
|
+
result = api_instance.post_conversations_emails(body)
|
|
4719
|
+
p result
|
|
4720
|
+
rescue PureCloud::ApiError => e
|
|
4721
|
+
puts "Exception when calling ConversationsApi->post_conversations_emails: #{e}"
|
|
4722
|
+
end
|
|
4723
|
+
~~~
|
|
4724
|
+
|
|
4725
|
+
### Parameters
|
|
4726
|
+
|
|
4727
|
+
Name | Type | Description | Notes
|
|
4728
|
+
------------- | ------------- | ------------- | -------------
|
|
4729
|
+
**body** | [**CreateEmailRequest**](CreateEmailRequest.html)| Create email request |
|
|
4730
|
+
{: class="table table-striped"}
|
|
4731
|
+
|
|
4732
|
+
|
|
4733
|
+
### Return type
|
|
4734
|
+
|
|
4735
|
+
[**EmailConversation**](EmailConversation.html)
|
|
4736
|
+
|
|
4737
|
+
### HTTP request headers
|
|
4738
|
+
|
|
4739
|
+
- **Content-Type**: application/json
|
|
4740
|
+
- **Accept**: application/json
|
|
4741
|
+
|
|
4742
|
+
|
|
4743
|
+
|
|
4744
|
+
<a name="post_conversations_faxes"></a>
|
|
4745
|
+
|
|
4746
|
+
## -[**FaxSendResponse**](FaxSendResponse.html) post_conversations_faxes(body)
|
|
4747
|
+
|
|
4748
|
+
Create Fax Conversation
|
|
4749
|
+
|
|
4750
|
+
|
|
4751
|
+
|
|
4752
|
+
Wraps POST /api/v2/conversations/faxes
|
|
4753
|
+
|
|
4754
|
+
|
|
4755
|
+
### Example
|
|
4756
|
+
~~~ruby
|
|
4757
|
+
# load the gem
|
|
4758
|
+
require 'purecloudplatformclientv2'
|
|
4759
|
+
# setup authorization
|
|
4760
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
4761
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
4762
|
+
environment = "mypurecloud.com"
|
|
4763
|
+
|
|
4764
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
4765
|
+
|
|
4766
|
+
PureCloud.configure do |config|
|
|
4767
|
+
config.access_token = @authToken
|
|
4768
|
+
end
|
|
4769
|
+
|
|
4770
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
4771
|
+
|
|
4772
|
+
body = PureCloud::FaxSendRequest.new # FaxSendRequest | Fax
|
|
4773
|
+
|
|
4774
|
+
|
|
4775
|
+
begin
|
|
4776
|
+
#Create Fax Conversation
|
|
4777
|
+
result = api_instance.post_conversations_faxes(body)
|
|
4778
|
+
p result
|
|
4779
|
+
rescue PureCloud::ApiError => e
|
|
4780
|
+
puts "Exception when calling ConversationsApi->post_conversations_faxes: #{e}"
|
|
4781
|
+
end
|
|
4782
|
+
~~~
|
|
4783
|
+
|
|
4784
|
+
### Parameters
|
|
4785
|
+
|
|
4786
|
+
Name | Type | Description | Notes
|
|
4787
|
+
------------- | ------------- | ------------- | -------------
|
|
4788
|
+
**body** | [**FaxSendRequest**](FaxSendRequest.html)| Fax |
|
|
4789
|
+
{: class="table table-striped"}
|
|
4790
|
+
|
|
4791
|
+
|
|
4792
|
+
### Return type
|
|
4793
|
+
|
|
4794
|
+
[**FaxSendResponse**](FaxSendResponse.html)
|
|
4795
|
+
|
|
4796
|
+
### HTTP request headers
|
|
4797
|
+
|
|
4798
|
+
- **Content-Type**: application/json
|
|
4799
|
+
- **Accept**: application/json
|
|
4800
|
+
|
|
4801
|
+
|
|
4802
|
+
|
|
4803
|
+
<a name="put_conversations_email_messages_draft"></a>
|
|
4804
|
+
|
|
4805
|
+
## -[**EmailMessage**](EmailMessage.html) put_conversations_email_messages_draft(email_id, body)
|
|
4806
|
+
|
|
4807
|
+
Update conversation draft reply
|
|
4808
|
+
|
|
4809
|
+
|
|
4810
|
+
|
|
4811
|
+
Wraps PUT /api/v2/conversations/emails/{emailId}/messages/draft
|
|
4812
|
+
|
|
4813
|
+
|
|
4814
|
+
### Example
|
|
4815
|
+
~~~ruby
|
|
4816
|
+
# load the gem
|
|
4817
|
+
require 'purecloudplatformclientv2'
|
|
4818
|
+
# setup authorization
|
|
4819
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
4820
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
4821
|
+
environment = "mypurecloud.com"
|
|
4822
|
+
|
|
4823
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
4824
|
+
|
|
4825
|
+
PureCloud.configure do |config|
|
|
4826
|
+
config.access_token = @authToken
|
|
4827
|
+
end
|
|
4828
|
+
|
|
4829
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
4830
|
+
|
|
4831
|
+
email_id = "email_id_example" # String | emailId
|
|
4832
|
+
|
|
4833
|
+
body = PureCloud::EmailMessage.new # EmailMessage | Draft
|
|
4834
|
+
|
|
4835
|
+
|
|
4836
|
+
begin
|
|
4837
|
+
#Update conversation draft reply
|
|
4838
|
+
result = api_instance.put_conversations_email_messages_draft(email_id, body)
|
|
4839
|
+
p result
|
|
4840
|
+
rescue PureCloud::ApiError => e
|
|
4841
|
+
puts "Exception when calling ConversationsApi->put_conversations_email_messages_draft: #{e}"
|
|
4842
|
+
end
|
|
4843
|
+
~~~
|
|
4844
|
+
|
|
4845
|
+
### Parameters
|
|
4846
|
+
|
|
4847
|
+
Name | Type | Description | Notes
|
|
4848
|
+
------------- | ------------- | ------------- | -------------
|
|
4849
|
+
**email_id** | **String**| emailId |
|
|
4850
|
+
**body** | [**EmailMessage**](EmailMessage.html)| Draft |
|
|
4851
|
+
{: class="table table-striped"}
|
|
4852
|
+
|
|
4853
|
+
|
|
4854
|
+
### Return type
|
|
4855
|
+
|
|
4856
|
+
[**EmailMessage**](EmailMessage.html)
|
|
4857
|
+
|
|
4858
|
+
### HTTP request headers
|
|
4859
|
+
|
|
4860
|
+
- **Content-Type**: application/json
|
|
4861
|
+
- **Accept**: application/json
|
|
4862
|
+
|
|
4863
|
+
|
|
4864
|
+
|