purecloud 0.67.1 → 0.68.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +3 -3
- data/bin/notificationMappings.json +4 -4
- data/config-ruby.json +1 -1
- data/doc_out/ActivityCode.html.md +20 -0
- data/doc_out/ActivityCodeContainer.html.md +13 -0
- data/doc_out/AgentActivityEntityListing.html.md +2 -2
- data/doc_out/AlertingApi.html.md +137 -35
- data/doc_out/AnalyticsApi.html.md +89 -23
- data/doc_out/AttemptLimitsEntityListing.html.md +2 -2
- data/doc_out/AttemptLimitsNotification.html.md +2 -1
- data/doc_out/AttributeEntityListing.html.md +2 -2
- data/doc_out/AttributesApi.html.md +25 -7
- data/doc_out/AuthorizationApi.html.md +69 -18
- data/doc_out/CalibrationEntityListing.html.md +2 -2
- data/doc_out/CallConversationEntityListing.html.md +2 -2
- data/doc_out/CallConversationNotificationCallMediaParticipant.html.md +1 -1
- data/doc_out/CallConversationNotificationParticipants.html.md +1 -1
- data/doc_out/CallableTimeSetEntityListing.html.md +2 -2
- data/doc_out/CallableTimeSetNotification.html.md +1 -1
- data/doc_out/CallbackConversationEntityListing.html.md +2 -2
- data/doc_out/CallbackConversationNotificationCallbackMediaParticipant.html.md +1 -1
- data/doc_out/CallbackConversationNotificationParticipants.html.md +1 -1
- data/doc_out/CampaignEntityListing.html.md +2 -2
- data/doc_out/CampaignNotification.html.md +2 -2
- data/doc_out/{CampaignNotificationError.html.md → CampaignNotificationRestErrorDetail.html.md} +2 -2
- data/doc_out/CampaignProgressNotification.html.md +1 -1
- data/doc_out/CampaignRuleEntityListing.html.md +2 -2
- data/doc_out/CampaignRuleNotification.html.md +1 -1
- data/doc_out/CampaignRuleNotificationCampaignRuleActionEntities.html.md +2 -2
- data/doc_out/CampaignRuleNotificationCampaignRuleEntities.html.md +2 -3
- data/doc_out/CampaignRuleNotificationUriReference.html.md +14 -0
- data/doc_out/CampaignScheduleNotification.html.md +2 -2
- data/doc_out/CampaignSequenceEntityListing.html.md +2 -2
- data/doc_out/CampaignSequenceNotification.html.md +2 -2
- data/doc_out/CertificateAuthorityEntityListing.html.md +2 -2
- data/doc_out/ChannelEntityListing.html.md +2 -2
- data/doc_out/ChatConversationEntityListing.html.md +2 -2
- data/doc_out/ChatConversationNotificationChatMediaParticipant.html.md +1 -1
- data/doc_out/ChatConversationNotificationParticipants.html.md +1 -1
- data/doc_out/CobrowseConversationEntityListing.html.md +2 -2
- data/doc_out/CobrowseConversationNotificationCobrowseMediaParticipant.html.md +1 -1
- data/doc_out/CobrowseConversationNotificationParticipants.html.md +1 -1
- data/doc_out/CommandStatusEntityListing.html.md +2 -2
- data/doc_out/ContactListEntityListing.html.md +2 -2
- data/doc_out/ContactListNotification.html.md +2 -2
- data/doc_out/{ContactListNotificationPhoneColumn_.html.md → ContactListNotificationContactPhoneNumberColumn.html.md} +2 -2
- data/doc_out/ContentManagementApi.html.md +153 -39
- data/doc_out/ConversationEntityListing.html.md +2 -2
- data/doc_out/ConversationsApi.html.md +421 -76
- data/doc_out/CreateEmailRequest.html.md +23 -0
- data/doc_out/CreateWebChatRequest.html.md +19 -0
- data/doc_out/DIDEntityListing.html.md +2 -2
- data/doc_out/DIDPoolEntityListing.html.md +2 -2
- data/doc_out/DecisionsFileMetadataEntityListing.html.md +2 -2
- data/doc_out/DncListEntityListing.html.md +2 -2
- data/doc_out/DncListNotification.html.md +1 -1
- data/doc_out/DocumentAuditEntityListing.html.md +2 -2
- data/doc_out/DocumentDataV2Notification.html.md +26 -0
- data/doc_out/{RecordingDataNotificationUserData.html.md → DocumentDataV2NotificationCreatedBy.html.md} +2 -2
- data/doc_out/DocumentDataV2NotificationLockData.html.md +15 -0
- data/doc_out/DocumentDataV2NotificationLockInfo.html.md +15 -0
- data/doc_out/{DocumentDataNotificationUserData.html.md → DocumentDataV2NotificationUserData.html.md} +2 -2
- data/doc_out/{DocumentDataNotificationWorkspace.html.md → DocumentDataV2NotificationWorkspace.html.md} +2 -2
- data/doc_out/{DocumentDataNotificationWorkspaceData.html.md → DocumentDataV2NotificationWorkspaceData.html.md} +2 -2
- data/doc_out/DocumentEntityListing.html.md +2 -2
- data/doc_out/DomainEdgeSoftwareVersionDtoEntityListing.html.md +2 -2
- data/doc_out/DomainEntityListing.html.md +2 -2
- data/doc_out/DomainEntityListingEvaluationForm.html.md +2 -2
- data/doc_out/DomainEntityListingQueryResult.html.md +2 -2
- data/doc_out/DomainOrganizationRole.html.md +1 -1
- data/doc_out/DomainOrganizationRoleCreate.html.md +1 -1
- data/doc_out/DomainOrganizationRoleUpdate.html.md +1 -1
- data/doc_out/EdgeEntityListing.html.md +2 -2
- data/doc_out/EdgeGroupEntityListing.html.md +2 -2
- data/doc_out/EdgeLineEntityListing.html.md +2 -2
- data/doc_out/EdgeRebootParameters.html.md +13 -0
- data/doc_out/EmailConversationEntityListing.html.md +2 -2
- data/doc_out/EmailConversationNotificationEmailMediaParticipant.html.md +1 -1
- data/doc_out/EmailConversationNotificationParticipants.html.md +1 -1
- data/doc_out/EmailMessageListing.html.md +2 -2
- data/doc_out/EncryptionKeyEntityListing.html.md +2 -2
- data/doc_out/EndpointEntityListing.html.md +2 -2
- data/doc_out/Entry.html.md +2 -2
- data/doc_out/EntryFeatureBoolean.html.md +14 -0
- data/doc_out/EvaluationEntityListing.html.md +2 -2
- data/doc_out/EvaluationFormEntityListing.html.md +2 -2
- data/doc_out/EvaluatorActivityEntityListing.html.md +2 -2
- data/doc_out/ExtensionEntityListing.html.md +2 -2
- data/doc_out/ExtensionPoolEntityListing.html.md +2 -2
- data/doc_out/FaxApi.html.md +25 -7
- data/doc_out/FaxDataV2Notification.html.md +29 -0
- data/doc_out/FaxDataV2NotificationLockData.html.md +15 -0
- data/doc_out/FaxDataV2NotificationLockInfo.html.md +15 -0
- data/doc_out/{FaxDataNotificationUserData.html.md → FaxDataV2NotificationUserData.html.md} +2 -2
- data/doc_out/{FaxDataNotificationWorkspaceData.html.md → FaxDataV2NotificationWorkspaceData.html.md} +2 -2
- data/doc_out/FaxDocumentEntityListing.html.md +2 -2
- data/doc_out/GeolocationApi.html.md +17 -5
- data/doc_out/GreetingListing.html.md +2 -2
- data/doc_out/GreetingsApi.html.md +65 -17
- data/doc_out/GroupEntityListing.html.md +2 -2
- data/doc_out/GroupsApi.html.md +45 -12
- data/doc_out/HeartBeatAlertContainer.html.md +2 -2
- data/doc_out/HeartBeatRuleContainer.html.md +2 -2
- data/doc_out/IdentityProviderApi.html.md +89 -23
- data/doc_out/InboundDomainEntityListing.html.md +2 -2
- data/doc_out/InboundRouteEntityListing.html.md +2 -2
- data/doc_out/InteractionStatsAlertContainer.html.md +2 -2
- data/doc_out/InteractionStatsRuleContainer.html.md +2 -2
- data/doc_out/JsonNode.html.md +2 -2
- data/doc_out/KeywordSetEntityListing.html.md +2 -2
- data/doc_out/LanguageEntityListing.html.md +2 -2
- data/doc_out/LanguagesApi.html.md +41 -11
- data/doc_out/LibraryEntityListing.html.md +2 -2
- data/doc_out/LineBaseEntityListing.html.md +2 -2
- data/doc_out/LineEntityListing.html.md +2 -2
- data/doc_out/LocalEncryptionConfigurationListing.html.md +2 -2
- data/doc_out/LocationsApi.html.md +17 -5
- data/doc_out/LogicalInterfaceEntityListing.html.md +2 -2
- data/doc_out/NotificationsApi.html.md +29 -8
- data/doc_out/OAuthApi.html.md +25 -7
- data/doc_out/OAuthClientEntityListing.html.md +2 -2
- data/doc_out/OAuthProviderEntityListing.html.md +2 -2
- data/doc_out/Organization.html.md +1 -0
- data/doc_out/OrganizationApi.html.md +70 -3
- data/doc_out/OrganizationPresenceEntityListing.html.md +2 -2
- data/doc_out/OrganizationRoleEntityListing.html.md +2 -2
- data/doc_out/OrphanRecordingListing.html.md +2 -2
- data/doc_out/OutOfOfficeNotification.html.md +1 -1
- data/doc_out/OutboundApi.html.md +323 -95
- data/doc_out/OutboundRouteBaseEntityListing.html.md +2 -2
- data/doc_out/OutboundRouteEntityListing.html.md +2 -2
- data/doc_out/PermissionCollectionEntityListing.html.md +2 -2
- data/doc_out/PhoneBaseEntityListing.html.md +2 -2
- data/doc_out/PhoneEntityListing.html.md +2 -2
- data/doc_out/PhoneMetaBaseEntityListing.html.md +2 -2
- data/doc_out/PhysicalInterfaceEntityListing.html.md +2 -2
- data/doc_out/PolicyEntityListing.html.md +2 -2
- data/doc_out/PresenceApi.html.md +33 -9
- data/doc_out/QualityApi.html.md +128 -33
- data/doc_out/QualityAuditPage.html.md +2 -2
- data/doc_out/QueueEntityListing.html.md +2 -2
- data/doc_out/QueueMemberEntityListing.html.md +2 -2
- data/doc_out/RecordingApi.html.md +133 -34
- data/doc_out/RecordingDataV2Notification.html.md +29 -0
- data/doc_out/{RecordingDataNotificationConversationData.html.md → RecordingDataV2NotificationConversationData.html.md} +2 -2
- data/doc_out/RecordingDataV2NotificationLockData.html.md +15 -0
- data/doc_out/RecordingDataV2NotificationLockInfo.html.md +15 -0
- data/doc_out/{DocumentDataNotificationCreatedBy.html.md → RecordingDataV2NotificationUserData.html.md} +2 -2
- data/doc_out/{RecordingDataNotificationWorkspaceData.html.md → RecordingDataV2NotificationWorkspaceData.html.md} +2 -2
- data/doc_out/ReportMetaDataEntityListing.html.md +2 -2
- data/doc_out/ReportRunEntryEntityDomainListing.html.md +2 -2
- data/doc_out/ReportScheduleEntityListing.html.md +2 -2
- data/doc_out/ResponseEntityList.html.md +2 -2
- data/doc_out/ResponseEntityListing.html.md +2 -2
- data/doc_out/ResponseManagementApi.html.md +45 -12
- data/doc_out/ResponseSetEntityListing.html.md +2 -2
- data/doc_out/ResponseSetNotification.html.md +1 -1
- data/doc_out/RoutingApi.html.md +193 -49
- data/doc_out/RoutingStatusAlertContainer.html.md +2 -2
- data/doc_out/RoutingStatusRuleContainer.html.md +2 -2
- data/doc_out/RuleSetEntityListing.html.md +2 -2
- data/doc_out/RuleSetNotification.html.md +1 -1
- data/doc_out/RuleSetNotificationCondition.html.md +1 -1
- data/doc_out/RuleSetNotificationConditions.html.md +1 -1
- data/doc_out/SchemaCategoryEntityListing.html.md +2 -2
- data/doc_out/SchemaReferenceEntityListing.html.md +2 -2
- data/doc_out/ScreenRecordingSessionListing.html.md +2 -2
- data/doc_out/ScreenShareConversationNotificationParticipants.html.md +1 -1
- data/doc_out/ScreenShareConversationNotificationScreenShareMediaParticipant.html.md +1 -1
- data/doc_out/ScriptEntityListing.html.md +2 -2
- data/doc_out/ScriptsApi.html.md +37 -10
- data/doc_out/SearchApi.html.md +49 -13
- data/doc_out/SecurityProfileEntityListing.html.md +2 -2
- data/doc_out/SequenceScheduleNotification.html.md +2 -2
- data/doc_out/ShareEntityListing.html.md +2 -2
- data/doc_out/SiteEntityListing.html.md +2 -2
- data/doc_out/SkillEntityListing.html.md +2 -2
- data/doc_out/SocialConversationNotificationParticipants.html.md +1 -1
- data/doc_out/SocialConversationNotificationSocialMediaParticipant.html.md +1 -1
- data/doc_out/StationEntityListing.html.md +2 -2
- data/doc_out/StationsApi.html.md +13 -4
- data/doc_out/SuggestApi.html.md +17 -5
- data/doc_out/TagValueEntityListing.html.md +2 -2
- data/doc_out/TelephonyProvidersEdgeApi.html.md +479 -121
- data/doc_out/TimeZoneEntityListing.html.md +2 -2
- data/doc_out/TokensApi.html.md +5 -2
- data/doc_out/TrunkBaseEntityListing.html.md +2 -2
- data/doc_out/TrunkEntityListing.html.md +2 -2
- data/doc_out/TrunkMetabaseEntityListing.html.md +2 -2
- data/doc_out/UserEntityListing.html.md +2 -2
- data/doc_out/UserListScheduleRequestBody.html.md +15 -0
- data/doc_out/UserPresenceAlertContainer.html.md +2 -2
- data/doc_out/UserPresenceRuleContainer.html.md +2 -2
- data/doc_out/UserQueueEntityListing.html.md +2 -2
- data/doc_out/UserRecordingEntityListing.html.md +2 -2
- data/doc_out/UserRecordingsApi.html.md +25 -7
- data/doc_out/UserSchedule.html.md +14 -0
- data/doc_out/UserScheduleActivity.html.md +18 -0
- data/doc_out/UserScheduleContainer.html.md +14 -0
- data/doc_out/UserScheduleFullDayTimeOffMarker.html.md +17 -0
- data/doc_out/UserScheduleShift.html.md +15 -0
- data/doc_out/UserSkillEntityListing.html.md +2 -2
- data/doc_out/UsersApi.html.md +169 -43
- data/doc_out/UtilitiesApi.html.md +13 -4
- data/doc_out/VideoConversationNotificationParticipants.html.md +1 -1
- data/doc_out/VideoConversationNotificationVideoMediaParticipant.html.md +1 -1
- data/doc_out/VoicemailApi.html.md +89 -23
- data/doc_out/VoicemailMessageEntityListing.html.md +2 -2
- data/doc_out/WfmUserEntityListing.html.md +13 -0
- data/doc_out/WorkforceManagementApi.html.md +227 -13
- data/doc_out/WorkspaceEntityListing.html.md +2 -2
- data/doc_out/WorkspaceMemberEntityListing.html.md +2 -2
- data/doc_out/WrapUpCodeMappingNotification.html.md +0 -1
- data/doc_out/WrapupCodeEntityListing.html.md +2 -2
- data/doc_out/index.html.md +3 -3
- data/lib/purecloud.rb +34 -20
- data/lib/purecloud/api/conversations_api.rb +120 -0
- data/lib/purecloud/api/organization_api.rb +57 -0
- data/lib/purecloud/api/outbound_api.rb +9 -9
- data/lib/purecloud/api/quality_api.rb +7 -0
- data/lib/purecloud/api/telephony_providers_edge_api.rb +3 -1
- data/lib/purecloud/api/workforce_management_api.rb +185 -3
- data/lib/purecloud/api_client.rb +1 -1
- data/lib/purecloud/models/activity_code.rb +253 -0
- data/lib/purecloud/models/activity_code_container.rb +169 -0
- data/lib/purecloud/models/agent_activity_entity_listing.rb +17 -17
- data/lib/purecloud/models/attempt_limits_entity_listing.rb +17 -17
- data/lib/purecloud/models/attempt_limits_notification.rb +24 -14
- data/lib/purecloud/models/attribute_entity_listing.rb +17 -17
- data/lib/purecloud/models/calibration_entity_listing.rb +17 -17
- data/lib/purecloud/models/call_conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/call_conversation_notification_call_media_participant.rb +1 -1
- data/lib/purecloud/models/call_conversation_notification_participants.rb +1 -1
- data/lib/purecloud/models/callable_time_set_entity_listing.rb +17 -17
- data/lib/purecloud/models/callable_time_set_notification.rb +13 -13
- data/lib/purecloud/models/callback_conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/callback_conversation_notification_callback_media_participant.rb +1 -1
- data/lib/purecloud/models/callback_conversation_notification_participants.rb +1 -1
- data/lib/purecloud/models/campaign_entity_listing.rb +17 -17
- data/lib/purecloud/models/campaign_notification.rb +15 -15
- data/lib/purecloud/models/{campaign_notification_error.rb → campaign_notification_rest_error_detail.rb} +1 -1
- data/lib/purecloud/models/campaign_progress_notification.rb +1 -1
- data/lib/purecloud/models/campaign_rule_entity_listing.rb +17 -17
- data/lib/purecloud/models/campaign_rule_notification.rb +14 -14
- data/lib/purecloud/models/campaign_rule_notification_campaign_rule_action_entities.rb +2 -2
- data/lib/purecloud/models/campaign_rule_notification_campaign_rule_entities.rb +3 -13
- data/lib/purecloud/models/campaign_rule_notification_uri_reference.rb +175 -0
- data/lib/purecloud/models/campaign_schedule_notification.rb +14 -14
- data/lib/purecloud/models/campaign_sequence_entity_listing.rb +17 -17
- data/lib/purecloud/models/campaign_sequence_notification.rb +15 -15
- data/lib/purecloud/models/certificate_authority_entity_listing.rb +17 -17
- data/lib/purecloud/models/channel_entity_listing.rb +17 -17
- data/lib/purecloud/models/chat_conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/chat_conversation_notification_chat_media_participant.rb +1 -1
- data/lib/purecloud/models/chat_conversation_notification_participants.rb +1 -1
- data/lib/purecloud/models/cobrowse_conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/cobrowse_conversation_notification_cobrowse_media_participant.rb +1 -1
- data/lib/purecloud/models/cobrowse_conversation_notification_participants.rb +1 -1
- data/lib/purecloud/models/command_status_entity_listing.rb +17 -17
- data/lib/purecloud/models/contact_list_entity_listing.rb +17 -17
- data/lib/purecloud/models/contact_list_notification.rb +14 -14
- data/lib/purecloud/models/{contact_list_notification_phone_column_.rb → contact_list_notification_contact_phone_number_column.rb} +1 -1
- data/lib/purecloud/models/contact_list_notification_import_status.rb +1 -1
- data/lib/purecloud/models/conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/create_email_request.rb +280 -0
- data/lib/purecloud/models/create_web_chat_request.rb +236 -0
- data/lib/purecloud/models/decisions_file_metadata_entity_listing.rb +17 -17
- data/lib/purecloud/models/did_entity_listing.rb +17 -17
- data/lib/purecloud/models/did_pool_entity_listing.rb +17 -17
- data/lib/purecloud/models/dnc_list_entity_listing.rb +17 -17
- data/lib/purecloud/models/dnc_list_notification.rb +14 -14
- data/lib/purecloud/models/dnc_list_notification_import_status.rb +1 -1
- data/lib/purecloud/models/document_audit_entity_listing.rb +17 -17
- data/lib/purecloud/models/{document_data_notification.rb → document_data_v2_notification.rb} +9 -29
- data/lib/purecloud/models/{recording_data_notification_user_data.rb → document_data_v2_notification_created_by.rb} +1 -1
- data/lib/purecloud/models/{document_data_notification_lock_info.rb → document_data_v2_notification_lock_data.rb} +4 -4
- data/lib/purecloud/models/{document_data_notification_lock_data.rb → document_data_v2_notification_lock_info.rb} +4 -4
- data/lib/purecloud/models/{document_data_notification_user_data.rb → document_data_v2_notification_user_data.rb} +1 -1
- data/lib/purecloud/models/{document_data_notification_workspace.rb → document_data_v2_notification_workspace.rb} +1 -1
- data/lib/purecloud/models/{document_data_notification_workspace_data.rb → document_data_v2_notification_workspace_data.rb} +1 -1
- data/lib/purecloud/models/document_entity_listing.rb +17 -17
- data/lib/purecloud/models/domain_edge_software_version_dto_entity_listing.rb +17 -17
- data/lib/purecloud/models/domain_entity_listing.rb +17 -17
- data/lib/purecloud/models/domain_entity_listing_evaluation_form.rb +17 -17
- data/lib/purecloud/models/domain_entity_listing_query_result.rb +17 -17
- data/lib/purecloud/models/domain_organization_role.rb +11 -11
- data/lib/purecloud/models/domain_organization_role_create.rb +11 -11
- data/lib/purecloud/models/domain_organization_role_update.rb +11 -11
- data/lib/purecloud/models/edge_entity_listing.rb +17 -17
- data/lib/purecloud/models/edge_group_entity_listing.rb +17 -17
- data/lib/purecloud/models/edge_line_entity_listing.rb +17 -17
- data/lib/purecloud/models/edge_reboot_parameters.rb +166 -0
- data/lib/purecloud/models/email_conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/email_conversation_notification_email_media_participant.rb +1 -1
- data/lib/purecloud/models/email_conversation_notification_participants.rb +1 -1
- data/lib/purecloud/models/email_message_listing.rb +17 -17
- data/lib/purecloud/models/encryption_key_entity_listing.rb +17 -17
- data/lib/purecloud/models/endpoint_entity_listing.rb +17 -17
- data/lib/purecloud/models/entry.rb +8 -10
- data/lib/purecloud/models/entry_feature_boolean.rb +184 -0
- data/lib/purecloud/models/evaluation_entity_listing.rb +17 -17
- data/lib/purecloud/models/evaluation_form_entity_listing.rb +17 -17
- data/lib/purecloud/models/evaluator_activity_entity_listing.rb +17 -17
- data/lib/purecloud/models/extension_entity_listing.rb +17 -17
- data/lib/purecloud/models/extension_pool_entity_listing.rb +17 -17
- data/lib/purecloud/models/{fax_data_notification.rb → fax_data_v2_notification.rb} +9 -29
- data/lib/purecloud/models/{fax_data_notification_lock_info.rb → fax_data_v2_notification_lock_data.rb} +4 -4
- data/lib/purecloud/models/{fax_data_notification_lock_data.rb → fax_data_v2_notification_lock_info.rb} +4 -4
- data/lib/purecloud/models/{fax_data_notification_user_data.rb → fax_data_v2_notification_user_data.rb} +1 -1
- data/lib/purecloud/models/{fax_data_notification_workspace_data.rb → fax_data_v2_notification_workspace_data.rb} +1 -1
- data/lib/purecloud/models/fax_document_entity_listing.rb +17 -17
- data/lib/purecloud/models/greeting_listing.rb +17 -17
- data/lib/purecloud/models/group_entity_listing.rb +17 -17
- data/lib/purecloud/models/heart_beat_alert_container.rb +17 -17
- data/lib/purecloud/models/heart_beat_rule_container.rb +17 -17
- data/lib/purecloud/models/import_status_notification.rb +1 -1
- data/lib/purecloud/models/inbound_domain_entity_listing.rb +17 -17
- data/lib/purecloud/models/inbound_route_entity_listing.rb +17 -17
- data/lib/purecloud/models/interaction_stats_alert_container.rb +17 -17
- data/lib/purecloud/models/interaction_stats_rule_container.rb +17 -17
- data/lib/purecloud/models/json_node.rb +24 -24
- data/lib/purecloud/models/keyword_set_entity_listing.rb +17 -17
- data/lib/purecloud/models/language_entity_listing.rb +17 -17
- data/lib/purecloud/models/library_entity_listing.rb +17 -17
- data/lib/purecloud/models/line_base_entity_listing.rb +17 -17
- data/lib/purecloud/models/line_entity_listing.rb +17 -17
- data/lib/purecloud/models/local_encryption_configuration_listing.rb +17 -17
- data/lib/purecloud/models/logical_interface_entity_listing.rb +17 -17
- data/lib/purecloud/models/o_auth_client_entity_listing.rb +17 -17
- data/lib/purecloud/models/o_auth_provider_entity_listing.rb +17 -17
- data/lib/purecloud/models/organization.rb +17 -4
- data/lib/purecloud/models/organization_presence_entity_listing.rb +17 -17
- data/lib/purecloud/models/organization_role_entity_listing.rb +17 -17
- data/lib/purecloud/models/orphan_recording_listing.rb +17 -17
- data/lib/purecloud/models/out_of_office_notification.rb +1 -1
- data/lib/purecloud/models/outbound_route_base_entity_listing.rb +17 -17
- data/lib/purecloud/models/outbound_route_entity_listing.rb +17 -17
- data/lib/purecloud/models/permission_collection_entity_listing.rb +17 -17
- data/lib/purecloud/models/phone_base_entity_listing.rb +17 -17
- data/lib/purecloud/models/phone_entity_listing.rb +17 -17
- data/lib/purecloud/models/phone_meta_base_entity_listing.rb +17 -17
- data/lib/purecloud/models/physical_interface_entity_listing.rb +17 -17
- data/lib/purecloud/models/policy_entity_listing.rb +17 -17
- data/lib/purecloud/models/quality_audit_page.rb +17 -17
- data/lib/purecloud/models/queue_entity_listing.rb +17 -17
- data/lib/purecloud/models/queue_member_entity_listing.rb +17 -17
- data/lib/purecloud/models/{recording_data_notification.rb → recording_data_v2_notification.rb} +10 -30
- data/lib/purecloud/models/{recording_data_notification_conversation_data.rb → recording_data_v2_notification_conversation_data.rb} +1 -1
- data/lib/purecloud/models/recording_data_v2_notification_lock_data.rb +185 -0
- data/lib/purecloud/models/recording_data_v2_notification_lock_info.rb +185 -0
- data/lib/purecloud/models/{document_data_notification_created_by.rb → recording_data_v2_notification_user_data.rb} +1 -1
- data/lib/purecloud/models/{recording_data_notification_workspace_data.rb → recording_data_v2_notification_workspace_data.rb} +1 -1
- data/lib/purecloud/models/report_meta_data_entity_listing.rb +17 -17
- data/lib/purecloud/models/report_run_entry_entity_domain_listing.rb +17 -17
- data/lib/purecloud/models/report_schedule_entity_listing.rb +17 -17
- data/lib/purecloud/models/response_entity_list.rb +17 -17
- data/lib/purecloud/models/response_entity_listing.rb +17 -17
- data/lib/purecloud/models/response_set_entity_listing.rb +17 -17
- data/lib/purecloud/models/response_set_notification.rb +13 -13
- data/lib/purecloud/models/routing_status_alert_container.rb +17 -17
- data/lib/purecloud/models/routing_status_rule_container.rb +17 -17
- data/lib/purecloud/models/rule_set_entity_listing.rb +17 -17
- data/lib/purecloud/models/rule_set_notification.rb +1 -1
- data/lib/purecloud/models/rule_set_notification_condition.rb +11 -11
- data/lib/purecloud/models/rule_set_notification_conditions.rb +18 -18
- data/lib/purecloud/models/rule_set_notification_rule.rb +9 -0
- data/lib/purecloud/models/rule_set_notification_rules.rb +9 -0
- data/lib/purecloud/models/schema_category_entity_listing.rb +17 -17
- data/lib/purecloud/models/schema_reference_entity_listing.rb +17 -17
- data/lib/purecloud/models/screen_recording_session_listing.rb +17 -17
- data/lib/purecloud/models/screen_share_conversation_notification_participants.rb +1 -1
- data/lib/purecloud/models/screen_share_conversation_notification_screen_share_media_participant.rb +1 -1
- data/lib/purecloud/models/script_entity_listing.rb +17 -17
- data/lib/purecloud/models/security_profile_entity_listing.rb +17 -17
- data/lib/purecloud/models/sequence_schedule_notification.rb +14 -14
- data/lib/purecloud/models/share_entity_listing.rb +17 -17
- data/lib/purecloud/models/site_entity_listing.rb +17 -17
- data/lib/purecloud/models/skill_entity_listing.rb +17 -17
- data/lib/purecloud/models/social_conversation_notification_participants.rb +1 -1
- data/lib/purecloud/models/social_conversation_notification_social_media_participant.rb +1 -1
- data/lib/purecloud/models/station_entity_listing.rb +17 -17
- data/lib/purecloud/models/tag_value_entity_listing.rb +17 -17
- data/lib/purecloud/models/time_zone_entity_listing.rb +17 -17
- data/lib/purecloud/models/trunk_base_entity_listing.rb +17 -17
- data/lib/purecloud/models/trunk_entity_listing.rb +17 -17
- data/lib/purecloud/models/trunk_metabase_entity_listing.rb +17 -17
- data/lib/purecloud/models/user_entity_listing.rb +17 -17
- data/lib/purecloud/models/user_list_schedule_request_body.rb +191 -0
- data/lib/purecloud/models/user_presence_alert_container.rb +17 -17
- data/lib/purecloud/models/user_presence_rule_container.rb +17 -17
- data/lib/purecloud/models/user_queue_entity_listing.rb +17 -17
- data/lib/purecloud/models/user_recording_entity_listing.rb +17 -17
- data/lib/purecloud/models/user_schedule.rb +182 -0
- data/lib/purecloud/models/user_schedule_activity.rb +222 -0
- data/lib/purecloud/models/user_schedule_container.rb +180 -0
- data/lib/purecloud/models/user_schedule_full_day_time_off_marker.rb +211 -0
- data/lib/purecloud/models/user_schedule_shift.rb +191 -0
- data/lib/purecloud/models/user_skill_entity_listing.rb +17 -17
- data/lib/purecloud/models/video_conversation_notification_participants.rb +1 -1
- data/lib/purecloud/models/video_conversation_notification_video_media_participant.rb +1 -1
- data/lib/purecloud/models/voicemail_message_entity_listing.rb +17 -17
- data/lib/purecloud/models/wfm_user_entity_listing.rb +167 -0
- data/lib/purecloud/models/workspace_entity_listing.rb +17 -17
- data/lib/purecloud/models/workspace_member_entity_listing.rb +17 -17
- data/lib/purecloud/models/wrap_up_code_mapping_notification.rb +4 -14
- data/lib/purecloud/models/wrapup_code_entity_listing.rb +17 -17
- data/lib/purecloud/version.rb +1 -1
- data/newVersion.md +1 -1
- data/swagger.json +1 -1
- data/swagger_template/api_doc.mustache +5 -2
- data/version.json +1 -1
- metadata +70 -42
- data/doc_out/DocumentDataNotification.html.md +0 -28
- data/doc_out/DocumentDataNotificationLockData.html.md +0 -15
- data/doc_out/DocumentDataNotificationLockInfo.html.md +0 -15
- data/doc_out/FaxDataNotification.html.md +0 -31
- data/doc_out/FaxDataNotificationLockData.html.md +0 -15
- data/doc_out/FaxDataNotificationLockInfo.html.md +0 -15
- data/doc_out/RecordingDataNotification.html.md +0 -31
- data/doc_out/RecordingDataNotificationLockData.html.md +0 -15
- data/doc_out/RecordingDataNotificationLockInfo.html.md +0 -15
- data/lib/purecloud/models/recording_data_notification_lock_data.rb +0 -185
- data/lib/purecloud/models/recording_data_notification_lock_info.rb +0 -185
|
@@ -11,11 +11,11 @@ title: ConversationEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -6,83 +6,85 @@ title: ConversationsApi
|
|
|
6
6
|
|
|
7
7
|
All URIs are relative to *https://api.mypurecloud.com*
|
|
8
8
|
|
|
9
|
-
Method |
|
|
9
|
+
Method | Description
|
|
10
10
|
------------- | ------------- | -------------
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
11
|
+
[**delete_calls_call_id_participants_participant_id_consult**](ConversationsApi.html#delete_calls_call_id_participants_participant_id_consult) | Cancel the transfer
|
|
12
|
+
[**delete_conversation_id_participants_participant_id_codes_addcommunicationcode**](ConversationsApi.html#delete_conversation_id_participants_participant_id_codes_addcommunicationcode) | Delete a code used to add a communication to this participant
|
|
13
|
+
[**delete_emails_email_id_messages_draft_attachments_attachment_id**](ConversationsApi.html#delete_emails_email_id_messages_draft_attachments_attachment_id) | Delete attachment from draft
|
|
14
|
+
[**get_callbacks**](ConversationsApi.html#get_callbacks) | Get callback conversations
|
|
15
|
+
[**get_callbacks_callback_id**](ConversationsApi.html#get_callbacks_callback_id) | Get callback conversation
|
|
16
|
+
[**get_callbacks_callback_id_participants_participant_id_wrapup**](ConversationsApi.html#get_callbacks_callback_id_participants_participant_id_wrapup) | Get the wrap-up for this conversation participant.
|
|
17
|
+
[**get_callbacks_callback_id_participants_participant_id_wrapupcodes**](ConversationsApi.html#get_callbacks_callback_id_participants_participant_id_wrapupcodes) | Get list of wrapup codes for this conversation participant
|
|
18
|
+
[**get_calls**](ConversationsApi.html#get_calls) | Get recent conversations
|
|
19
|
+
[**get_calls_call_id**](ConversationsApi.html#get_calls_call_id) | Get call conversation
|
|
20
|
+
[**get_calls_call_id_participants_participant_id_wrapup**](ConversationsApi.html#get_calls_call_id_participants_participant_id_wrapup) | Get the wrap-up for this conversation participant.
|
|
21
|
+
[**get_calls_call_id_participants_participant_id_wrapupcodes**](ConversationsApi.html#get_calls_call_id_participants_participant_id_wrapupcodes) | Get list of wrapup codes for this conversation participant
|
|
22
|
+
[**get_calls_history**](ConversationsApi.html#get_calls_history) | Get call history
|
|
23
|
+
[**get_calls_maximumconferenceparties**](ConversationsApi.html#get_calls_maximumconferenceparties) | Get the maximum number of participants that this user can have on a conference
|
|
24
|
+
[**get_chats**](ConversationsApi.html#get_chats) | Get recent chat conversations
|
|
25
|
+
[**get_chats_chat_id**](ConversationsApi.html#get_chats_chat_id) | Get chat conversation
|
|
26
|
+
[**get_chats_chat_id_participants_participant_id_wrapup**](ConversationsApi.html#get_chats_chat_id_participants_participant_id_wrapup) | Get the wrap-up for this conversation participant.
|
|
27
|
+
[**get_chats_chat_id_participants_participant_id_wrapupcodes**](ConversationsApi.html#get_chats_chat_id_participants_participant_id_wrapupcodes) | Get list of wrapup codes for this conversation participant
|
|
28
|
+
[**get_cobrowsesessions**](ConversationsApi.html#get_cobrowsesessions) | Get recent cobrowse conversations
|
|
29
|
+
[**get_cobrowsesessions_cobrowse_id**](ConversationsApi.html#get_cobrowsesessions_cobrowse_id) | Get cobrowse conversation
|
|
30
|
+
[**get_cobrowsesessions_cobrowse_id_participants_participant_id_wrapup**](ConversationsApi.html#get_cobrowsesessions_cobrowse_id_participants_participant_id_wrapup) | Get the wrap-up for this conversation participant.
|
|
31
|
+
[**get_cobrowsesessions_cobrowse_id_participants_participant_id_wrapupcodes**](ConversationsApi.html#get_cobrowsesessions_cobrowse_id_participants_participant_id_wrapupcodes) | Get list of wrapup codes for this conversation participant
|
|
32
|
+
[**get_conversation_id**](ConversationsApi.html#get_conversation_id) | Get conversation
|
|
33
|
+
[**get_conversation_id_participants_participant_id_wrapup**](ConversationsApi.html#get_conversation_id_participants_participant_id_wrapup) | Get the wrap-up for this conversation participant.
|
|
34
|
+
[**get_conversation_id_participants_participant_id_wrapupcodes**](ConversationsApi.html#get_conversation_id_participants_participant_id_wrapupcodes) | Get list of wrapup codes for this conversation participant
|
|
35
|
+
[**get_conversations**](ConversationsApi.html#get_conversations) | Get conversations
|
|
36
|
+
[**get_conversations_conversation_id_details**](ConversationsApi.html#get_conversations_conversation_id_details) | Get a conversation by id
|
|
37
|
+
[**get_emails**](ConversationsApi.html#get_emails) | Get recent email conversations
|
|
38
|
+
[**get_emails_email_id**](ConversationsApi.html#get_emails_email_id) | Get email conversation
|
|
39
|
+
[**get_emails_email_id_messages**](ConversationsApi.html#get_emails_email_id_messages) | Get conversation messages
|
|
40
|
+
[**get_emails_email_id_messages_draft**](ConversationsApi.html#get_emails_email_id_messages_draft) | Get conversation draft reply
|
|
41
|
+
[**get_emails_email_id_messages_message_id**](ConversationsApi.html#get_emails_email_id_messages_message_id) | Get conversation message
|
|
42
|
+
[**get_emails_email_id_participants_participant_id_wrapup**](ConversationsApi.html#get_emails_email_id_participants_participant_id_wrapup) | Get the wrap-up for this conversation participant.
|
|
43
|
+
[**get_emails_email_id_participants_participant_id_wrapupcodes**](ConversationsApi.html#get_emails_email_id_participants_participant_id_wrapupcodes) | Get list of wrapup codes for this conversation participant
|
|
44
|
+
[**patch_callbacks_callback_id**](ConversationsApi.html#patch_callbacks_callback_id) | Update a conversation by disconnecting all of the participants
|
|
45
|
+
[**patch_callbacks_callback_id_participants_participant_id**](ConversationsApi.html#patch_callbacks_callback_id_participants_participant_id) | Update conversation participant
|
|
46
|
+
[**patch_callbacks_callback_id_participants_participant_id_attributes**](ConversationsApi.html#patch_callbacks_callback_id_participants_participant_id_attributes) | Update the attributes on a conversation participant.
|
|
47
|
+
[**patch_callbacks_callback_id_participants_participant_id_communications_communication_id**](ConversationsApi.html#patch_callbacks_callback_id_participants_participant_id_communications_communication_id) | Update conversation participant's communication by disconnecting it.
|
|
48
|
+
[**patch_calls_call_id**](ConversationsApi.html#patch_calls_call_id) | Update a conversation by setting it's recording state, merging in other conversations to create a conference, or disconnecting all of the participants
|
|
49
|
+
[**patch_calls_call_id_participants_participant_id**](ConversationsApi.html#patch_calls_call_id_participants_participant_id) | Update conversation participant
|
|
50
|
+
[**patch_calls_call_id_participants_participant_id_attributes**](ConversationsApi.html#patch_calls_call_id_participants_participant_id_attributes) | Update the attributes on a conversation participant.
|
|
51
|
+
[**patch_calls_call_id_participants_participant_id_communications_communication_id**](ConversationsApi.html#patch_calls_call_id_participants_participant_id_communications_communication_id) | Update conversation participant's communication by disconnecting it.
|
|
52
|
+
[**patch_calls_call_id_participants_participant_id_consult**](ConversationsApi.html#patch_calls_call_id_participants_participant_id_consult) | Change who can speak
|
|
53
|
+
[**patch_chats_chat_id**](ConversationsApi.html#patch_chats_chat_id) | Update a conversation by disconnecting all of the participants
|
|
54
|
+
[**patch_chats_chat_id_participants_participant_id**](ConversationsApi.html#patch_chats_chat_id_participants_participant_id) | Update conversation participant
|
|
55
|
+
[**patch_chats_chat_id_participants_participant_id_attributes**](ConversationsApi.html#patch_chats_chat_id_participants_participant_id_attributes) | Update the attributes on a conversation participant.
|
|
56
|
+
[**patch_chats_chat_id_participants_participant_id_communications_communication_id**](ConversationsApi.html#patch_chats_chat_id_participants_participant_id_communications_communication_id) | Update conversation participant's communication by disconnecting it.
|
|
57
|
+
[**patch_cobrowsesessions_cobrowse_id**](ConversationsApi.html#patch_cobrowsesessions_cobrowse_id) | Update a conversation by disconnecting all of the participants
|
|
58
|
+
[**patch_cobrowsesessions_cobrowse_id_participants_participant_id**](ConversationsApi.html#patch_cobrowsesessions_cobrowse_id_participants_participant_id) | Update conversation participant
|
|
59
|
+
[**patch_cobrowsesessions_cobrowse_id_participants_participant_id_attributes**](ConversationsApi.html#patch_cobrowsesessions_cobrowse_id_participants_participant_id_attributes) | Update the attributes on a conversation participant.
|
|
60
|
+
[**patch_cobrowsesessions_cobrowse_id_participants_participant_id_communications_communication_id**](ConversationsApi.html#patch_cobrowsesessions_cobrowse_id_participants_participant_id_communications_communication_id) | Update conversation participant's communication by disconnecting it.
|
|
61
|
+
[**patch_conversation_id_participants_participant_id**](ConversationsApi.html#patch_conversation_id_participants_participant_id) | Update a participant.
|
|
62
|
+
[**patch_conversation_id_participants_participant_id_attributes**](ConversationsApi.html#patch_conversation_id_participants_participant_id_attributes) | Update the attributes on a conversation participant.
|
|
63
|
+
[**patch_emails_email_id**](ConversationsApi.html#patch_emails_email_id) | Update a conversation by disconnecting all of the participants
|
|
64
|
+
[**patch_emails_email_id_participants_participant_id**](ConversationsApi.html#patch_emails_email_id_participants_participant_id) | Update conversation participant
|
|
65
|
+
[**patch_emails_email_id_participants_participant_id_attributes**](ConversationsApi.html#patch_emails_email_id_participants_participant_id_attributes) | Update the attributes on a conversation participant.
|
|
66
|
+
[**patch_emails_email_id_participants_participant_id_communications_communication_id**](ConversationsApi.html#patch_emails_email_id_participants_participant_id_communications_communication_id) | Update conversation participant's communication by disconnecting it.
|
|
67
|
+
[**post_callbacks**](ConversationsApi.html#post_callbacks) | Create a Callback
|
|
68
|
+
[**post_callbacks_callback_id_participants_participant_id_replace**](ConversationsApi.html#post_callbacks_callback_id_participants_participant_id_replace) | Replace this participant with the specified user and/or address
|
|
69
|
+
[**post_calls**](ConversationsApi.html#post_calls) | Create a call conversation
|
|
70
|
+
[**post_calls_call_id**](ConversationsApi.html#post_calls_call_id) | Add a new call to a conversation
|
|
71
|
+
[**post_calls_call_id_participants**](ConversationsApi.html#post_calls_call_id_participants) | Add participants to a conversation
|
|
72
|
+
[**post_calls_call_id_participants_participant_id_consult**](ConversationsApi.html#post_calls_call_id_participants_participant_id_consult) | Initiate and update consult transfer
|
|
73
|
+
[**post_calls_call_id_participants_participant_id_monitor**](ConversationsApi.html#post_calls_call_id_participants_participant_id_monitor) | Listen in on the conversation from the point of view of a given participant.
|
|
74
|
+
[**post_calls_call_id_participants_participant_id_replace**](ConversationsApi.html#post_calls_call_id_participants_participant_id_replace) | Replace this participant with the specified user and/or address
|
|
75
|
+
[**post_chats**](ConversationsApi.html#post_chats) | Create a web chat conversation
|
|
76
|
+
[**post_chats_chat_id_participants_participant_id_replace**](ConversationsApi.html#post_chats_chat_id_participants_participant_id_replace) | Replace this participant with the specified user and/or address
|
|
77
|
+
[**post_cobrowsesessions_cobrowse_id_participants_participant_id_replace**](ConversationsApi.html#post_cobrowsesessions_cobrowse_id_participants_participant_id_replace) | Replace this participant with the specified user and/or address
|
|
78
|
+
[**post_conversation_id_participants_participant_id_callbacks**](ConversationsApi.html#post_conversation_id_participants_participant_id_callbacks) | Create a new callback for the specified participant on the conversation.
|
|
79
|
+
[**post_conversation_id_participants_participant_id_replace**](ConversationsApi.html#post_conversation_id_participants_participant_id_replace) | Replace this participant with the specified user and/or address
|
|
80
|
+
[**post_conversations_aggregates_query**](ConversationsApi.html#post_conversations_aggregates_query) | Query for conversation aggregates
|
|
81
|
+
[**post_conversations_conversation_id_details_properties**](ConversationsApi.html#post_conversations_conversation_id_details_properties) | Index conversation properties
|
|
82
|
+
[**post_conversations_details_query**](ConversationsApi.html#post_conversations_details_query) | Query for conversation details
|
|
83
|
+
[**post_emails**](ConversationsApi.html#post_emails) | Create an email conversation
|
|
84
|
+
[**post_emails_email_id_messages**](ConversationsApi.html#post_emails_email_id_messages) | Send an email reply
|
|
85
|
+
[**post_emails_email_id_participants_participant_id_replace**](ConversationsApi.html#post_emails_email_id_participants_participant_id_replace) | Replace this participant with the specified user and/or address
|
|
86
|
+
[**post_faxes**](ConversationsApi.html#post_faxes) | Create Fax Conversation
|
|
87
|
+
[**put_emails_email_id_messages_draft**](ConversationsApi.html#put_emails_email_id_messages_draft) | Update conversation draft reply
|
|
86
88
|
{: class="table table-striped"}
|
|
87
89
|
|
|
88
90
|
<a name="delete_calls_call_id_participants_participant_id_consult"></a>
|
|
@@ -93,6 +95,9 @@ Cancel the transfer
|
|
|
93
95
|
|
|
94
96
|
|
|
95
97
|
|
|
98
|
+
Wraps DELETE /api/v2/conversations/calls/{callId}/participants/{participantId}/consult
|
|
99
|
+
|
|
100
|
+
|
|
96
101
|
### Example
|
|
97
102
|
~~~ruby
|
|
98
103
|
# load the gem
|
|
@@ -152,6 +157,9 @@ Delete a code used to add a communication to this participant
|
|
|
152
157
|
|
|
153
158
|
|
|
154
159
|
|
|
160
|
+
Wraps DELETE /api/v2/conversations/{conversationId}/participants/{participantId}/codes/{addCommunicationCode}
|
|
161
|
+
|
|
162
|
+
|
|
155
163
|
### Example
|
|
156
164
|
~~~ruby
|
|
157
165
|
# load the gem
|
|
@@ -213,6 +221,9 @@ Delete attachment from draft
|
|
|
213
221
|
|
|
214
222
|
|
|
215
223
|
|
|
224
|
+
Wraps DELETE /api/v2/conversations/emails/{emailId}/messages/draft/attachments/{attachmentId}
|
|
225
|
+
|
|
226
|
+
|
|
216
227
|
### Example
|
|
217
228
|
~~~ruby
|
|
218
229
|
# load the gem
|
|
@@ -272,6 +283,9 @@ Get callback conversations
|
|
|
272
283
|
|
|
273
284
|
|
|
274
285
|
|
|
286
|
+
Wraps GET /api/v2/conversations/callbacks
|
|
287
|
+
|
|
288
|
+
|
|
275
289
|
### Example
|
|
276
290
|
~~~ruby
|
|
277
291
|
# load the gem
|
|
@@ -322,6 +336,9 @@ Get callback conversation
|
|
|
322
336
|
|
|
323
337
|
|
|
324
338
|
|
|
339
|
+
Wraps GET /api/v2/conversations/callbacks/{callbackId}
|
|
340
|
+
|
|
341
|
+
|
|
325
342
|
### Example
|
|
326
343
|
~~~ruby
|
|
327
344
|
# load the gem
|
|
@@ -378,6 +395,9 @@ Get the wrap-up for this conversation participant.
|
|
|
378
395
|
|
|
379
396
|
|
|
380
397
|
|
|
398
|
+
Wraps GET /api/v2/conversations/callbacks/{callbackId}/participants/{participantId}/wrapup
|
|
399
|
+
|
|
400
|
+
|
|
381
401
|
### Example
|
|
382
402
|
~~~ruby
|
|
383
403
|
# load the gem
|
|
@@ -441,6 +461,9 @@ Get list of wrapup codes for this conversation participant
|
|
|
441
461
|
|
|
442
462
|
|
|
443
463
|
|
|
464
|
+
Wraps GET /api/v2/conversations/callbacks/{callbackId}/participants/{participantId}/wrapupcodes
|
|
465
|
+
|
|
466
|
+
|
|
444
467
|
### Example
|
|
445
468
|
~~~ruby
|
|
446
469
|
# load the gem
|
|
@@ -500,6 +523,9 @@ Get recent conversations
|
|
|
500
523
|
|
|
501
524
|
|
|
502
525
|
|
|
526
|
+
Wraps GET /api/v2/conversations/calls
|
|
527
|
+
|
|
528
|
+
|
|
503
529
|
### Example
|
|
504
530
|
~~~ruby
|
|
505
531
|
# load the gem
|
|
@@ -550,6 +576,9 @@ Get call conversation
|
|
|
550
576
|
|
|
551
577
|
|
|
552
578
|
|
|
579
|
+
Wraps GET /api/v2/conversations/calls/{callId}
|
|
580
|
+
|
|
581
|
+
|
|
553
582
|
### Example
|
|
554
583
|
~~~ruby
|
|
555
584
|
# load the gem
|
|
@@ -606,6 +635,9 @@ Get the wrap-up for this conversation participant.
|
|
|
606
635
|
|
|
607
636
|
|
|
608
637
|
|
|
638
|
+
Wraps GET /api/v2/conversations/calls/{callId}/participants/{participantId}/wrapup
|
|
639
|
+
|
|
640
|
+
|
|
609
641
|
### Example
|
|
610
642
|
~~~ruby
|
|
611
643
|
# load the gem
|
|
@@ -669,6 +701,9 @@ Get list of wrapup codes for this conversation participant
|
|
|
669
701
|
|
|
670
702
|
|
|
671
703
|
|
|
704
|
+
Wraps GET /api/v2/conversations/calls/{callId}/participants/{participantId}/wrapupcodes
|
|
705
|
+
|
|
706
|
+
|
|
672
707
|
### Example
|
|
673
708
|
~~~ruby
|
|
674
709
|
# load the gem
|
|
@@ -728,6 +763,9 @@ Get call history
|
|
|
728
763
|
|
|
729
764
|
|
|
730
765
|
|
|
766
|
+
Wraps GET /api/v2/conversations/calls/history
|
|
767
|
+
|
|
768
|
+
|
|
731
769
|
### Example
|
|
732
770
|
~~~ruby
|
|
733
771
|
# load the gem
|
|
@@ -789,6 +827,9 @@ Get the maximum number of participants that this user can have on a conference
|
|
|
789
827
|
|
|
790
828
|
|
|
791
829
|
|
|
830
|
+
Wraps GET /api/v2/conversations/calls/maximumconferenceparties
|
|
831
|
+
|
|
832
|
+
|
|
792
833
|
### Example
|
|
793
834
|
~~~ruby
|
|
794
835
|
# load the gem
|
|
@@ -839,6 +880,9 @@ Get recent chat conversations
|
|
|
839
880
|
|
|
840
881
|
|
|
841
882
|
|
|
883
|
+
Wraps GET /api/v2/conversations/chats
|
|
884
|
+
|
|
885
|
+
|
|
842
886
|
### Example
|
|
843
887
|
~~~ruby
|
|
844
888
|
# load the gem
|
|
@@ -889,6 +933,9 @@ Get chat conversation
|
|
|
889
933
|
|
|
890
934
|
|
|
891
935
|
|
|
936
|
+
Wraps GET /api/v2/conversations/chats/{chatId}
|
|
937
|
+
|
|
938
|
+
|
|
892
939
|
### Example
|
|
893
940
|
~~~ruby
|
|
894
941
|
# load the gem
|
|
@@ -945,6 +992,9 @@ Get the wrap-up for this conversation participant.
|
|
|
945
992
|
|
|
946
993
|
|
|
947
994
|
|
|
995
|
+
Wraps GET /api/v2/conversations/chats/{chatId}/participants/{participantId}/wrapup
|
|
996
|
+
|
|
997
|
+
|
|
948
998
|
### Example
|
|
949
999
|
~~~ruby
|
|
950
1000
|
# load the gem
|
|
@@ -1008,6 +1058,9 @@ Get list of wrapup codes for this conversation participant
|
|
|
1008
1058
|
|
|
1009
1059
|
|
|
1010
1060
|
|
|
1061
|
+
Wraps GET /api/v2/conversations/chats/{chatId}/participants/{participantId}/wrapupcodes
|
|
1062
|
+
|
|
1063
|
+
|
|
1011
1064
|
### Example
|
|
1012
1065
|
~~~ruby
|
|
1013
1066
|
# load the gem
|
|
@@ -1067,6 +1120,9 @@ Get recent cobrowse conversations
|
|
|
1067
1120
|
|
|
1068
1121
|
|
|
1069
1122
|
|
|
1123
|
+
Wraps GET /api/v2/conversations/cobrowsesessions
|
|
1124
|
+
|
|
1125
|
+
|
|
1070
1126
|
### Example
|
|
1071
1127
|
~~~ruby
|
|
1072
1128
|
# load the gem
|
|
@@ -1117,6 +1173,9 @@ Get cobrowse conversation
|
|
|
1117
1173
|
|
|
1118
1174
|
|
|
1119
1175
|
|
|
1176
|
+
Wraps GET /api/v2/conversations/cobrowsesessions/{cobrowseId}
|
|
1177
|
+
|
|
1178
|
+
|
|
1120
1179
|
### Example
|
|
1121
1180
|
~~~ruby
|
|
1122
1181
|
# load the gem
|
|
@@ -1173,6 +1232,9 @@ Get the wrap-up for this conversation participant.
|
|
|
1173
1232
|
|
|
1174
1233
|
|
|
1175
1234
|
|
|
1235
|
+
Wraps GET /api/v2/conversations/cobrowsesessions/{cobrowseId}/participants/{participantId}/wrapup
|
|
1236
|
+
|
|
1237
|
+
|
|
1176
1238
|
### Example
|
|
1177
1239
|
~~~ruby
|
|
1178
1240
|
# load the gem
|
|
@@ -1236,6 +1298,9 @@ Get list of wrapup codes for this conversation participant
|
|
|
1236
1298
|
|
|
1237
1299
|
|
|
1238
1300
|
|
|
1301
|
+
Wraps GET /api/v2/conversations/cobrowsesessions/{cobrowseId}/participants/{participantId}/wrapupcodes
|
|
1302
|
+
|
|
1303
|
+
|
|
1239
1304
|
### Example
|
|
1240
1305
|
~~~ruby
|
|
1241
1306
|
# load the gem
|
|
@@ -1295,6 +1360,9 @@ Get conversation
|
|
|
1295
1360
|
|
|
1296
1361
|
|
|
1297
1362
|
|
|
1363
|
+
Wraps GET /api/v2/conversations/{conversationId}
|
|
1364
|
+
|
|
1365
|
+
|
|
1298
1366
|
### Example
|
|
1299
1367
|
~~~ruby
|
|
1300
1368
|
# load the gem
|
|
@@ -1351,6 +1419,9 @@ Get the wrap-up for this conversation participant.
|
|
|
1351
1419
|
|
|
1352
1420
|
|
|
1353
1421
|
|
|
1422
|
+
Wraps GET /api/v2/conversations/{conversationId}/participants/{participantId}/wrapup
|
|
1423
|
+
|
|
1424
|
+
|
|
1354
1425
|
### Example
|
|
1355
1426
|
~~~ruby
|
|
1356
1427
|
# load the gem
|
|
@@ -1414,6 +1485,9 @@ Get list of wrapup codes for this conversation participant
|
|
|
1414
1485
|
|
|
1415
1486
|
|
|
1416
1487
|
|
|
1488
|
+
Wraps GET /api/v2/conversations/{conversationId}/participants/{participantId}/wrapupcodes
|
|
1489
|
+
|
|
1490
|
+
|
|
1417
1491
|
### Example
|
|
1418
1492
|
~~~ruby
|
|
1419
1493
|
# load the gem
|
|
@@ -1473,6 +1547,9 @@ Get conversations
|
|
|
1473
1547
|
|
|
1474
1548
|
|
|
1475
1549
|
|
|
1550
|
+
Wraps GET /api/v2/conversations
|
|
1551
|
+
|
|
1552
|
+
|
|
1476
1553
|
### Example
|
|
1477
1554
|
~~~ruby
|
|
1478
1555
|
# load the gem
|
|
@@ -1530,6 +1607,9 @@ Get a conversation by id
|
|
|
1530
1607
|
|
|
1531
1608
|
|
|
1532
1609
|
|
|
1610
|
+
Wraps GET /api/v2/analytics/conversations/{conversationId}/details
|
|
1611
|
+
|
|
1612
|
+
|
|
1533
1613
|
### Example
|
|
1534
1614
|
~~~ruby
|
|
1535
1615
|
# load the gem
|
|
@@ -1586,6 +1666,9 @@ Get recent email conversations
|
|
|
1586
1666
|
|
|
1587
1667
|
|
|
1588
1668
|
|
|
1669
|
+
Wraps GET /api/v2/conversations/emails
|
|
1670
|
+
|
|
1671
|
+
|
|
1589
1672
|
### Example
|
|
1590
1673
|
~~~ruby
|
|
1591
1674
|
# load the gem
|
|
@@ -1636,6 +1719,9 @@ Get email conversation
|
|
|
1636
1719
|
|
|
1637
1720
|
|
|
1638
1721
|
|
|
1722
|
+
Wraps GET /api/v2/conversations/emails/{emailId}
|
|
1723
|
+
|
|
1724
|
+
|
|
1639
1725
|
### Example
|
|
1640
1726
|
~~~ruby
|
|
1641
1727
|
# load the gem
|
|
@@ -1692,6 +1778,9 @@ Get conversation messages
|
|
|
1692
1778
|
|
|
1693
1779
|
|
|
1694
1780
|
|
|
1781
|
+
Wraps GET /api/v2/conversations/emails/{emailId}/messages
|
|
1782
|
+
|
|
1783
|
+
|
|
1695
1784
|
### Example
|
|
1696
1785
|
~~~ruby
|
|
1697
1786
|
# load the gem
|
|
@@ -1748,6 +1837,9 @@ Get conversation draft reply
|
|
|
1748
1837
|
|
|
1749
1838
|
|
|
1750
1839
|
|
|
1840
|
+
Wraps GET /api/v2/conversations/emails/{emailId}/messages/draft
|
|
1841
|
+
|
|
1842
|
+
|
|
1751
1843
|
### Example
|
|
1752
1844
|
~~~ruby
|
|
1753
1845
|
# load the gem
|
|
@@ -1804,6 +1896,9 @@ Get conversation message
|
|
|
1804
1896
|
|
|
1805
1897
|
|
|
1806
1898
|
|
|
1899
|
+
Wraps GET /api/v2/conversations/emails/{emailId}/messages/{messageId}
|
|
1900
|
+
|
|
1901
|
+
|
|
1807
1902
|
### Example
|
|
1808
1903
|
~~~ruby
|
|
1809
1904
|
# load the gem
|
|
@@ -1863,6 +1958,9 @@ Get the wrap-up for this conversation participant.
|
|
|
1863
1958
|
|
|
1864
1959
|
|
|
1865
1960
|
|
|
1961
|
+
Wraps GET /api/v2/conversations/emails/{emailId}/participants/{participantId}/wrapup
|
|
1962
|
+
|
|
1963
|
+
|
|
1866
1964
|
### Example
|
|
1867
1965
|
~~~ruby
|
|
1868
1966
|
# load the gem
|
|
@@ -1926,6 +2024,9 @@ Get list of wrapup codes for this conversation participant
|
|
|
1926
2024
|
|
|
1927
2025
|
|
|
1928
2026
|
|
|
2027
|
+
Wraps GET /api/v2/conversations/emails/{emailId}/participants/{participantId}/wrapupcodes
|
|
2028
|
+
|
|
2029
|
+
|
|
1929
2030
|
### Example
|
|
1930
2031
|
~~~ruby
|
|
1931
2032
|
# load the gem
|
|
@@ -1985,6 +2086,9 @@ Update a conversation by disconnecting all of the participants
|
|
|
1985
2086
|
|
|
1986
2087
|
|
|
1987
2088
|
|
|
2089
|
+
Wraps PATCH /api/v2/conversations/callbacks/{callbackId}
|
|
2090
|
+
|
|
2091
|
+
|
|
1988
2092
|
### Example
|
|
1989
2093
|
~~~ruby
|
|
1990
2094
|
# load the gem
|
|
@@ -2044,6 +2148,9 @@ Update conversation participant
|
|
|
2044
2148
|
|
|
2045
2149
|
|
|
2046
2150
|
|
|
2151
|
+
Wraps PATCH /api/v2/conversations/callbacks/{callbackId}/participants/{participantId}
|
|
2152
|
+
|
|
2153
|
+
|
|
2047
2154
|
### Example
|
|
2048
2155
|
~~~ruby
|
|
2049
2156
|
# load the gem
|
|
@@ -2105,6 +2212,9 @@ Update the attributes on a conversation participant.
|
|
|
2105
2212
|
|
|
2106
2213
|
|
|
2107
2214
|
|
|
2215
|
+
Wraps PATCH /api/v2/conversations/callbacks/{callbackId}/participants/{participantId}/attributes
|
|
2216
|
+
|
|
2217
|
+
|
|
2108
2218
|
### Example
|
|
2109
2219
|
~~~ruby
|
|
2110
2220
|
# load the gem
|
|
@@ -2166,6 +2276,9 @@ Update conversation participant's communication by disconnecting it.
|
|
|
2166
2276
|
|
|
2167
2277
|
|
|
2168
2278
|
|
|
2279
|
+
Wraps PATCH /api/v2/conversations/callbacks/{callbackId}/participants/{participantId}/communications/{communicationId}
|
|
2280
|
+
|
|
2281
|
+
|
|
2169
2282
|
### Example
|
|
2170
2283
|
~~~ruby
|
|
2171
2284
|
# load the gem
|
|
@@ -2231,6 +2344,9 @@ Update a conversation by setting it's recording state, merging in other conversa
|
|
|
2231
2344
|
|
|
2232
2345
|
|
|
2233
2346
|
|
|
2347
|
+
Wraps PATCH /api/v2/conversations/calls/{callId}
|
|
2348
|
+
|
|
2349
|
+
|
|
2234
2350
|
### Example
|
|
2235
2351
|
~~~ruby
|
|
2236
2352
|
# load the gem
|
|
@@ -2290,6 +2406,9 @@ Update conversation participant
|
|
|
2290
2406
|
|
|
2291
2407
|
|
|
2292
2408
|
|
|
2409
|
+
Wraps PATCH /api/v2/conversations/calls/{callId}/participants/{participantId}
|
|
2410
|
+
|
|
2411
|
+
|
|
2293
2412
|
### Example
|
|
2294
2413
|
~~~ruby
|
|
2295
2414
|
# load the gem
|
|
@@ -2351,6 +2470,9 @@ Update the attributes on a conversation participant.
|
|
|
2351
2470
|
|
|
2352
2471
|
|
|
2353
2472
|
|
|
2473
|
+
Wraps PATCH /api/v2/conversations/calls/{callId}/participants/{participantId}/attributes
|
|
2474
|
+
|
|
2475
|
+
|
|
2354
2476
|
### Example
|
|
2355
2477
|
~~~ruby
|
|
2356
2478
|
# load the gem
|
|
@@ -2412,6 +2534,9 @@ Update conversation participant's communication by disconnecting it.
|
|
|
2412
2534
|
|
|
2413
2535
|
|
|
2414
2536
|
|
|
2537
|
+
Wraps PATCH /api/v2/conversations/calls/{callId}/participants/{participantId}/communications/{communicationId}
|
|
2538
|
+
|
|
2539
|
+
|
|
2415
2540
|
### Example
|
|
2416
2541
|
~~~ruby
|
|
2417
2542
|
# load the gem
|
|
@@ -2477,6 +2602,9 @@ Change who can speak
|
|
|
2477
2602
|
|
|
2478
2603
|
|
|
2479
2604
|
|
|
2605
|
+
Wraps PATCH /api/v2/conversations/calls/{callId}/participants/{participantId}/consult
|
|
2606
|
+
|
|
2607
|
+
|
|
2480
2608
|
### Example
|
|
2481
2609
|
~~~ruby
|
|
2482
2610
|
# load the gem
|
|
@@ -2539,6 +2667,9 @@ Update a conversation by disconnecting all of the participants
|
|
|
2539
2667
|
|
|
2540
2668
|
|
|
2541
2669
|
|
|
2670
|
+
Wraps PATCH /api/v2/conversations/chats/{chatId}
|
|
2671
|
+
|
|
2672
|
+
|
|
2542
2673
|
### Example
|
|
2543
2674
|
~~~ruby
|
|
2544
2675
|
# load the gem
|
|
@@ -2598,6 +2729,9 @@ Update conversation participant
|
|
|
2598
2729
|
|
|
2599
2730
|
|
|
2600
2731
|
|
|
2732
|
+
Wraps PATCH /api/v2/conversations/chats/{chatId}/participants/{participantId}
|
|
2733
|
+
|
|
2734
|
+
|
|
2601
2735
|
### Example
|
|
2602
2736
|
~~~ruby
|
|
2603
2737
|
# load the gem
|
|
@@ -2659,6 +2793,9 @@ Update the attributes on a conversation participant.
|
|
|
2659
2793
|
|
|
2660
2794
|
|
|
2661
2795
|
|
|
2796
|
+
Wraps PATCH /api/v2/conversations/chats/{chatId}/participants/{participantId}/attributes
|
|
2797
|
+
|
|
2798
|
+
|
|
2662
2799
|
### Example
|
|
2663
2800
|
~~~ruby
|
|
2664
2801
|
# load the gem
|
|
@@ -2720,6 +2857,9 @@ Update conversation participant's communication by disconnecting it.
|
|
|
2720
2857
|
|
|
2721
2858
|
|
|
2722
2859
|
|
|
2860
|
+
Wraps PATCH /api/v2/conversations/chats/{chatId}/participants/{participantId}/communications/{communicationId}
|
|
2861
|
+
|
|
2862
|
+
|
|
2723
2863
|
### Example
|
|
2724
2864
|
~~~ruby
|
|
2725
2865
|
# load the gem
|
|
@@ -2785,6 +2925,9 @@ Update a conversation by disconnecting all of the participants
|
|
|
2785
2925
|
|
|
2786
2926
|
|
|
2787
2927
|
|
|
2928
|
+
Wraps PATCH /api/v2/conversations/cobrowsesessions/{cobrowseId}
|
|
2929
|
+
|
|
2930
|
+
|
|
2788
2931
|
### Example
|
|
2789
2932
|
~~~ruby
|
|
2790
2933
|
# load the gem
|
|
@@ -2844,6 +2987,9 @@ Update conversation participant
|
|
|
2844
2987
|
|
|
2845
2988
|
|
|
2846
2989
|
|
|
2990
|
+
Wraps PATCH /api/v2/conversations/cobrowsesessions/{cobrowseId}/participants/{participantId}
|
|
2991
|
+
|
|
2992
|
+
|
|
2847
2993
|
### Example
|
|
2848
2994
|
~~~ruby
|
|
2849
2995
|
# load the gem
|
|
@@ -2906,6 +3052,9 @@ Update the attributes on a conversation participant.
|
|
|
2906
3052
|
|
|
2907
3053
|
|
|
2908
3054
|
|
|
3055
|
+
Wraps PATCH /api/v2/conversations/cobrowsesessions/{cobrowseId}/participants/{participantId}/attributes
|
|
3056
|
+
|
|
3057
|
+
|
|
2909
3058
|
### Example
|
|
2910
3059
|
~~~ruby
|
|
2911
3060
|
# load the gem
|
|
@@ -2968,6 +3117,9 @@ Update conversation participant's communication by disconnecting it.
|
|
|
2968
3117
|
|
|
2969
3118
|
|
|
2970
3119
|
|
|
3120
|
+
Wraps PATCH /api/v2/conversations/cobrowsesessions/{cobrowseId}/participants/{participantId}/communications/{communicationId}
|
|
3121
|
+
|
|
3122
|
+
|
|
2971
3123
|
### Example
|
|
2972
3124
|
~~~ruby
|
|
2973
3125
|
# load the gem
|
|
@@ -3033,6 +3185,9 @@ Update a participant.
|
|
|
3033
3185
|
|
|
3034
3186
|
Update conversation participant.
|
|
3035
3187
|
|
|
3188
|
+
Wraps PATCH /api/v2/conversations/{conversationId}/participants/{participantId}
|
|
3189
|
+
|
|
3190
|
+
|
|
3036
3191
|
### Example
|
|
3037
3192
|
~~~ruby
|
|
3038
3193
|
# load the gem
|
|
@@ -3094,6 +3249,9 @@ Update the attributes on a conversation participant.
|
|
|
3094
3249
|
|
|
3095
3250
|
|
|
3096
3251
|
|
|
3252
|
+
Wraps PATCH /api/v2/conversations/{conversationId}/participants/{participantId}/attributes
|
|
3253
|
+
|
|
3254
|
+
|
|
3097
3255
|
### Example
|
|
3098
3256
|
~~~ruby
|
|
3099
3257
|
# load the gem
|
|
@@ -3155,6 +3313,9 @@ Update a conversation by disconnecting all of the participants
|
|
|
3155
3313
|
|
|
3156
3314
|
|
|
3157
3315
|
|
|
3316
|
+
Wraps PATCH /api/v2/conversations/emails/{emailId}
|
|
3317
|
+
|
|
3318
|
+
|
|
3158
3319
|
### Example
|
|
3159
3320
|
~~~ruby
|
|
3160
3321
|
# load the gem
|
|
@@ -3214,6 +3375,9 @@ Update conversation participant
|
|
|
3214
3375
|
|
|
3215
3376
|
|
|
3216
3377
|
|
|
3378
|
+
Wraps PATCH /api/v2/conversations/emails/{emailId}/participants/{participantId}
|
|
3379
|
+
|
|
3380
|
+
|
|
3217
3381
|
### Example
|
|
3218
3382
|
~~~ruby
|
|
3219
3383
|
# load the gem
|
|
@@ -3275,6 +3439,9 @@ Update the attributes on a conversation participant.
|
|
|
3275
3439
|
|
|
3276
3440
|
|
|
3277
3441
|
|
|
3442
|
+
Wraps PATCH /api/v2/conversations/emails/{emailId}/participants/{participantId}/attributes
|
|
3443
|
+
|
|
3444
|
+
|
|
3278
3445
|
### Example
|
|
3279
3446
|
~~~ruby
|
|
3280
3447
|
# load the gem
|
|
@@ -3336,6 +3503,9 @@ Update conversation participant's communication by disconnecting it.
|
|
|
3336
3503
|
|
|
3337
3504
|
|
|
3338
3505
|
|
|
3506
|
+
Wraps PATCH /api/v2/conversations/emails/{emailId}/participants/{participantId}/communications/{communicationId}
|
|
3507
|
+
|
|
3508
|
+
|
|
3339
3509
|
### Example
|
|
3340
3510
|
~~~ruby
|
|
3341
3511
|
# load the gem
|
|
@@ -3401,6 +3571,9 @@ Create a Callback
|
|
|
3401
3571
|
|
|
3402
3572
|
|
|
3403
3573
|
|
|
3574
|
+
Wraps POST /api/v2/conversations/callbacks
|
|
3575
|
+
|
|
3576
|
+
|
|
3404
3577
|
### Example
|
|
3405
3578
|
~~~ruby
|
|
3406
3579
|
# load the gem
|
|
@@ -3457,6 +3630,9 @@ Replace this participant with the specified user and/or address
|
|
|
3457
3630
|
|
|
3458
3631
|
|
|
3459
3632
|
|
|
3633
|
+
Wraps POST /api/v2/conversations/callbacks/{callbackId}/participants/{participantId}/replace
|
|
3634
|
+
|
|
3635
|
+
|
|
3460
3636
|
### Example
|
|
3461
3637
|
~~~ruby
|
|
3462
3638
|
# load the gem
|
|
@@ -3518,6 +3694,9 @@ Create a call conversation
|
|
|
3518
3694
|
|
|
3519
3695
|
|
|
3520
3696
|
|
|
3697
|
+
Wraps POST /api/v2/conversations/calls
|
|
3698
|
+
|
|
3699
|
+
|
|
3521
3700
|
### Example
|
|
3522
3701
|
~~~ruby
|
|
3523
3702
|
# load the gem
|
|
@@ -3574,6 +3753,9 @@ Add a new call to a conversation
|
|
|
3574
3753
|
|
|
3575
3754
|
|
|
3576
3755
|
|
|
3756
|
+
Wraps POST /api/v2/conversations/calls/{callId}
|
|
3757
|
+
|
|
3758
|
+
|
|
3577
3759
|
### Example
|
|
3578
3760
|
~~~ruby
|
|
3579
3761
|
# load the gem
|
|
@@ -3633,6 +3815,9 @@ Add participants to a conversation
|
|
|
3633
3815
|
|
|
3634
3816
|
|
|
3635
3817
|
|
|
3818
|
+
Wraps POST /api/v2/conversations/calls/{callId}/participants
|
|
3819
|
+
|
|
3820
|
+
|
|
3636
3821
|
### Example
|
|
3637
3822
|
~~~ruby
|
|
3638
3823
|
# load the gem
|
|
@@ -3692,6 +3877,9 @@ Initiate and update consult transfer
|
|
|
3692
3877
|
|
|
3693
3878
|
|
|
3694
3879
|
|
|
3880
|
+
Wraps POST /api/v2/conversations/calls/{callId}/participants/{participantId}/consult
|
|
3881
|
+
|
|
3882
|
+
|
|
3695
3883
|
### Example
|
|
3696
3884
|
~~~ruby
|
|
3697
3885
|
# load the gem
|
|
@@ -3754,6 +3942,9 @@ Listen in on the conversation from the point of view of a given participant.
|
|
|
3754
3942
|
|
|
3755
3943
|
|
|
3756
3944
|
|
|
3945
|
+
Wraps POST /api/v2/conversations/calls/{callId}/participants/{participantId}/monitor
|
|
3946
|
+
|
|
3947
|
+
|
|
3757
3948
|
### Example
|
|
3758
3949
|
~~~ruby
|
|
3759
3950
|
# load the gem
|
|
@@ -3812,6 +4003,9 @@ Replace this participant with the specified user and/or address
|
|
|
3812
4003
|
|
|
3813
4004
|
|
|
3814
4005
|
|
|
4006
|
+
Wraps POST /api/v2/conversations/calls/{callId}/participants/{participantId}/replace
|
|
4007
|
+
|
|
4008
|
+
|
|
3815
4009
|
### Example
|
|
3816
4010
|
~~~ruby
|
|
3817
4011
|
# load the gem
|
|
@@ -3865,6 +4059,65 @@ nil (empty response body)
|
|
|
3865
4059
|
|
|
3866
4060
|
|
|
3867
4061
|
|
|
4062
|
+
<a name="post_chats"></a>
|
|
4063
|
+
|
|
4064
|
+
## -[**ChatConversation**](ChatConversation.html) post_chats(body)
|
|
4065
|
+
|
|
4066
|
+
Create a web chat conversation
|
|
4067
|
+
|
|
4068
|
+
|
|
4069
|
+
|
|
4070
|
+
Wraps POST /api/v2/conversations/chats
|
|
4071
|
+
|
|
4072
|
+
|
|
4073
|
+
### Example
|
|
4074
|
+
~~~ruby
|
|
4075
|
+
# load the gem
|
|
4076
|
+
require 'purecloud'
|
|
4077
|
+
# setup authorization
|
|
4078
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
4079
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
4080
|
+
environment = "mypurecloud.com"
|
|
4081
|
+
|
|
4082
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
4083
|
+
|
|
4084
|
+
PureCloud.configure do |config|
|
|
4085
|
+
config.access_token = @authToken
|
|
4086
|
+
end
|
|
4087
|
+
|
|
4088
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
4089
|
+
|
|
4090
|
+
body = PureCloud::CreateWebChatRequest.new # CreateWebChatRequest | Create web chat request
|
|
4091
|
+
|
|
4092
|
+
|
|
4093
|
+
begin
|
|
4094
|
+
#Create a web chat conversation
|
|
4095
|
+
result = api_instance.post_chats(body)
|
|
4096
|
+
p result
|
|
4097
|
+
rescue PureCloud::ApiError => e
|
|
4098
|
+
puts "Exception when calling ConversationsApi->post_chats: #{e}"
|
|
4099
|
+
end
|
|
4100
|
+
~~~
|
|
4101
|
+
|
|
4102
|
+
### Parameters
|
|
4103
|
+
|
|
4104
|
+
Name | Type | Description | Notes
|
|
4105
|
+
------------- | ------------- | ------------- | -------------
|
|
4106
|
+
**body** | [**CreateWebChatRequest**](CreateWebChatRequest.html)| Create web chat request |
|
|
4107
|
+
{: class="table table-striped"}
|
|
4108
|
+
|
|
4109
|
+
|
|
4110
|
+
### Return type
|
|
4111
|
+
|
|
4112
|
+
[**ChatConversation**](ChatConversation.html)
|
|
4113
|
+
|
|
4114
|
+
### HTTP request headers
|
|
4115
|
+
|
|
4116
|
+
- **Content-Type**: application/json
|
|
4117
|
+
- **Accept**: application/json
|
|
4118
|
+
|
|
4119
|
+
|
|
4120
|
+
|
|
3868
4121
|
<a name="post_chats_chat_id_participants_participant_id_replace"></a>
|
|
3869
4122
|
|
|
3870
4123
|
## - post_chats_chat_id_participants_participant_id_replace(chat_id, participant_id, body)
|
|
@@ -3873,6 +4126,9 @@ Replace this participant with the specified user and/or address
|
|
|
3873
4126
|
|
|
3874
4127
|
|
|
3875
4128
|
|
|
4129
|
+
Wraps POST /api/v2/conversations/chats/{chatId}/participants/{participantId}/replace
|
|
4130
|
+
|
|
4131
|
+
|
|
3876
4132
|
### Example
|
|
3877
4133
|
~~~ruby
|
|
3878
4134
|
# load the gem
|
|
@@ -3934,6 +4190,9 @@ Replace this participant with the specified user and/or address
|
|
|
3934
4190
|
|
|
3935
4191
|
|
|
3936
4192
|
|
|
4193
|
+
Wraps POST /api/v2/conversations/cobrowsesessions/{cobrowseId}/participants/{participantId}/replace
|
|
4194
|
+
|
|
4195
|
+
|
|
3937
4196
|
### Example
|
|
3938
4197
|
~~~ruby
|
|
3939
4198
|
# load the gem
|
|
@@ -3996,6 +4255,9 @@ Create a new callback for the specified participant on the conversation.
|
|
|
3996
4255
|
|
|
3997
4256
|
|
|
3998
4257
|
|
|
4258
|
+
Wraps POST /api/v2/conversations/{conversationId}/participants/{participantId}/callbacks
|
|
4259
|
+
|
|
4260
|
+
|
|
3999
4261
|
### Example
|
|
4000
4262
|
~~~ruby
|
|
4001
4263
|
# load the gem
|
|
@@ -4058,6 +4320,9 @@ Replace this participant with the specified user and/or address
|
|
|
4058
4320
|
|
|
4059
4321
|
|
|
4060
4322
|
|
|
4323
|
+
Wraps POST /api/v2/conversations/{conversationId}/participants/{participantId}/replace
|
|
4324
|
+
|
|
4325
|
+
|
|
4061
4326
|
### Example
|
|
4062
4327
|
~~~ruby
|
|
4063
4328
|
# load the gem
|
|
@@ -4119,6 +4384,9 @@ Query for conversation aggregates
|
|
|
4119
4384
|
|
|
4120
4385
|
|
|
4121
4386
|
|
|
4387
|
+
Wraps POST /api/v2/analytics/conversations/aggregates/query
|
|
4388
|
+
|
|
4389
|
+
|
|
4122
4390
|
### Example
|
|
4123
4391
|
~~~ruby
|
|
4124
4392
|
# load the gem
|
|
@@ -4175,6 +4443,9 @@ Index conversation properties
|
|
|
4175
4443
|
|
|
4176
4444
|
|
|
4177
4445
|
|
|
4446
|
+
Wraps POST /api/v2/analytics/conversations/{conversationId}/details/properties
|
|
4447
|
+
|
|
4448
|
+
|
|
4178
4449
|
### Example
|
|
4179
4450
|
~~~ruby
|
|
4180
4451
|
# load the gem
|
|
@@ -4234,6 +4505,9 @@ Query for conversation details
|
|
|
4234
4505
|
|
|
4235
4506
|
|
|
4236
4507
|
|
|
4508
|
+
Wraps POST /api/v2/analytics/conversations/details/query
|
|
4509
|
+
|
|
4510
|
+
|
|
4237
4511
|
### Example
|
|
4238
4512
|
~~~ruby
|
|
4239
4513
|
# load the gem
|
|
@@ -4282,6 +4556,65 @@ Name | Type | Description | Notes
|
|
|
4282
4556
|
|
|
4283
4557
|
|
|
4284
4558
|
|
|
4559
|
+
<a name="post_emails"></a>
|
|
4560
|
+
|
|
4561
|
+
## -[**EmailConversation**](EmailConversation.html) post_emails(body)
|
|
4562
|
+
|
|
4563
|
+
Create an email conversation
|
|
4564
|
+
|
|
4565
|
+
|
|
4566
|
+
|
|
4567
|
+
Wraps POST /api/v2/conversations/emails
|
|
4568
|
+
|
|
4569
|
+
|
|
4570
|
+
### Example
|
|
4571
|
+
~~~ruby
|
|
4572
|
+
# load the gem
|
|
4573
|
+
require 'purecloud'
|
|
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
|
+
body = PureCloud::CreateEmailRequest.new # CreateEmailRequest | Create email request
|
|
4588
|
+
|
|
4589
|
+
|
|
4590
|
+
begin
|
|
4591
|
+
#Create an email conversation
|
|
4592
|
+
result = api_instance.post_emails(body)
|
|
4593
|
+
p result
|
|
4594
|
+
rescue PureCloud::ApiError => e
|
|
4595
|
+
puts "Exception when calling ConversationsApi->post_emails: #{e}"
|
|
4596
|
+
end
|
|
4597
|
+
~~~
|
|
4598
|
+
|
|
4599
|
+
### Parameters
|
|
4600
|
+
|
|
4601
|
+
Name | Type | Description | Notes
|
|
4602
|
+
------------- | ------------- | ------------- | -------------
|
|
4603
|
+
**body** | [**CreateEmailRequest**](CreateEmailRequest.html)| Create email request |
|
|
4604
|
+
{: class="table table-striped"}
|
|
4605
|
+
|
|
4606
|
+
|
|
4607
|
+
### Return type
|
|
4608
|
+
|
|
4609
|
+
[**EmailConversation**](EmailConversation.html)
|
|
4610
|
+
|
|
4611
|
+
### HTTP request headers
|
|
4612
|
+
|
|
4613
|
+
- **Content-Type**: application/json
|
|
4614
|
+
- **Accept**: application/json
|
|
4615
|
+
|
|
4616
|
+
|
|
4617
|
+
|
|
4285
4618
|
<a name="post_emails_email_id_messages"></a>
|
|
4286
4619
|
|
|
4287
4620
|
## -[**EmailMessage**](EmailMessage.html) post_emails_email_id_messages(email_id, body)
|
|
@@ -4290,6 +4623,9 @@ Send an email reply
|
|
|
4290
4623
|
|
|
4291
4624
|
|
|
4292
4625
|
|
|
4626
|
+
Wraps POST /api/v2/conversations/emails/{emailId}/messages
|
|
4627
|
+
|
|
4628
|
+
|
|
4293
4629
|
### Example
|
|
4294
4630
|
~~~ruby
|
|
4295
4631
|
# load the gem
|
|
@@ -4349,6 +4685,9 @@ Replace this participant with the specified user and/or address
|
|
|
4349
4685
|
|
|
4350
4686
|
|
|
4351
4687
|
|
|
4688
|
+
Wraps POST /api/v2/conversations/emails/{emailId}/participants/{participantId}/replace
|
|
4689
|
+
|
|
4690
|
+
|
|
4352
4691
|
### Example
|
|
4353
4692
|
~~~ruby
|
|
4354
4693
|
# load the gem
|
|
@@ -4410,6 +4749,9 @@ Create Fax Conversation
|
|
|
4410
4749
|
|
|
4411
4750
|
|
|
4412
4751
|
|
|
4752
|
+
Wraps POST /api/v2/conversations/faxes
|
|
4753
|
+
|
|
4754
|
+
|
|
4413
4755
|
### Example
|
|
4414
4756
|
~~~ruby
|
|
4415
4757
|
# load the gem
|
|
@@ -4466,6 +4808,9 @@ Update conversation draft reply
|
|
|
4466
4808
|
|
|
4467
4809
|
|
|
4468
4810
|
|
|
4811
|
+
Wraps PUT /api/v2/conversations/emails/{emailId}/messages/draft
|
|
4812
|
+
|
|
4813
|
+
|
|
4469
4814
|
### Example
|
|
4470
4815
|
~~~ruby
|
|
4471
4816
|
# load the gem
|