purecloudplatformclientv2 91.0.0 → 96.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/docs/AfterCallWork.md +15 -0
- data/docs/AmazonLexRequest.md +14 -0
- data/docs/AnalyticsApi.md +67 -1
- data/docs/AnalyticsProposedAgent.md +14 -0
- data/docs/AnalyticsSession.md +6 -0
- data/docs/ArchitectApi.md +51 -49
- data/docs/ArrayNode.md +4 -4
- data/docs/AuditApi.md +130 -0
- data/docs/AuditRealtimeQueryRequest.md +18 -0
- data/docs/AuditRealtimeQueryResultsResponse.md +17 -0
- data/docs/AvailableTopic.md +1 -0
- data/docs/Biography.md +1 -0
- data/docs/BuAgentSchedulesQueryResponse.md +1 -0
- data/docs/ButtonComponent.md +16 -0
- data/docs/Call.md +1 -0
- data/docs/CallBasic.md +1 -0
- data/docs/Callback.md +1 -0
- data/docs/CallbackBasic.md +1 -0
- data/docs/CoachingApi.md +115 -30
- data/docs/CoachingAppointmentAggregateRequest.md +16 -0
- data/docs/CoachingAppointmentAggregateResponse.md +13 -0
- data/docs/CoachingAppointmentResponse.md +1 -0
- data/docs/CoachingNotification.md +1 -1
- data/docs/Cobrowsesession.md +1 -0
- data/docs/CommonCampaign.md +17 -0
- data/docs/CommonCampaignDivisionView.md +17 -0
- data/docs/CommonCampaignDivisionViewEntityListing.md +22 -0
- data/docs/CommonCampaignEntityListing.md +22 -0
- data/docs/Contact.md +1 -0
- data/docs/ContentActions.md +17 -0
- data/docs/ContentAttachment.md +19 -0
- data/docs/ContentGeneric.md +19 -0
- data/docs/ContentList.md +19 -0
- data/docs/ContentLocation.md +17 -0
- data/docs/ContentNotificationTemplate.md +17 -0
- data/docs/ContentQuickReply.md +16 -0
- data/docs/ConversationAssociation.md +1 -1
- data/docs/ConversationChat.md +1 -0
- data/docs/ConversationEventTopicAfterCallWork.md +15 -0
- data/docs/ConversationEventTopicCall.md +1 -0
- data/docs/ConversationEventTopicCallback.md +1 -0
- data/docs/ConversationEventTopicChat.md +1 -0
- data/docs/ConversationEventTopicCobrowse.md +1 -0
- data/docs/ConversationEventTopicEmail.md +1 -0
- data/docs/ConversationEventTopicMessage.md +2 -0
- data/docs/ConversationEventTopicScreenshare.md +1 -0
- data/docs/ConversationEventTopicSocialExpression.md +1 -0
- data/docs/ConversationEventTopicVideo.md +1 -0
- data/docs/ConversationMetrics.md +15 -0
- data/docs/ConversationsApi.md +73 -4
- data/docs/CreateCoachingAppointmentRequest.md +1 -1
- data/docs/CursorContactListing.md +16 -0
- data/docs/CursorNoteListing.md +16 -0
- data/docs/CursorOrganizationListing.md +16 -0
- data/docs/CursorRelationshipListing.md +16 -0
- data/docs/EdgeGroup.md +1 -0
- data/docs/Education.md +17 -0
- data/docs/Email.md +1 -0
- data/docs/EntityListing.md +1 -5
- data/docs/ExternalContactsApi.md +285 -9
- data/docs/ExternalOrganizationTrustorLink.md +1 -2
- data/docs/FacebookIntegrationUpdateRequest.md +14 -0
- data/docs/GoogleDialogflowCustomSettings.md +13 -0
- data/docs/HistoricalAdherenceActuals.md +15 -0
- data/docs/HistoricalAdherenceDayMetrics.md +23 -0
- data/docs/HistoricalAdherenceExceptionInfo.md +21 -0
- data/docs/HistoricalAdherenceQueryResult.md +21 -0
- data/docs/JourneyAggregateDataContainer.md +14 -0
- data/docs/JourneyAggregateQueryClause.md +14 -0
- data/docs/JourneyAggregateQueryFilter.md +15 -0
- data/docs/JourneyAggregateQueryPredicate.md +17 -0
- data/docs/JourneyAggregateQueryResponse.md +13 -0
- data/docs/JourneyAggregationQuery.md +21 -0
- data/docs/JourneyAggregationView.md +16 -0
- data/docs/JourneyApi.md +78 -0
- data/docs/JsonNode.md +4 -4
- data/docs/KnowledgeSearchRequest.md +3 -3
- data/docs/LanguageUnderstandingApi.md +165 -31
- data/docs/ListItemComponent.md +19 -0
- data/docs/Message.md +1 -0
- data/docs/MessageContent.md +19 -0
- data/docs/MessagingCampaign.md +28 -0
- data/docs/MessagingCampaignDivisionView.md +16 -0
- data/docs/MessagingCampaignDivisionViewEntityListing.md +22 -0
- data/docs/MessagingCampaignEntityListing.md +22 -0
- data/docs/NluDomainVersion.md +2 -1
- data/docs/NotificationTemplateBody.md +14 -0
- data/docs/NotificationTemplateFooter.md +13 -0
- data/docs/NotificationTemplateHeader.md +16 -0
- data/docs/NotificationTemplateParameter.md +14 -0
- data/docs/NotificationsApi.md +1 -1
- data/docs/OAuthClient.md +2 -0
- data/docs/OAuthClientListing.md +2 -0
- data/docs/OAuthClientRequest.md +2 -0
- data/docs/ObservationValue.md +3 -1
- data/docs/OrgOAuthClient.md +2 -0
- data/docs/OutboundApi.md +881 -76
- data/docs/Permissions.md +0 -2
- data/docs/PhoneCapabilities.md +1 -0
- data/docs/PostTextMessage.md +15 -0
- data/docs/PostTextRequest.md +23 -0
- data/docs/PostTextResponse.md +20 -0
- data/docs/PresenceApi.md +206 -6
- data/docs/PresenceExpand.md +17 -0
- data/docs/QueryRequestClause.md +14 -0
- data/docs/QueryRequestFilter.md +14 -0
- data/docs/QueryRequestPredicate.md +14 -0
- data/docs/QueryResponseData.md +14 -0
- data/docs/QueryResponseGroupedData.md +14 -0
- data/docs/QueryResponseMetric.md +14 -0
- data/docs/QueryResponseStats.md +13 -0
- data/docs/QueueConversationEventTopicAfterCallWork.md +15 -0
- data/docs/QueueConversationEventTopicCall.md +1 -0
- data/docs/QueueConversationEventTopicCallback.md +1 -0
- data/docs/QueueConversationEventTopicChat.md +1 -0
- data/docs/QueueConversationEventTopicCobrowse.md +1 -0
- data/docs/QueueConversationEventTopicEmail.md +1 -0
- data/docs/QueueConversationEventTopicMessage.md +2 -0
- data/docs/QueueConversationEventTopicScreenshare.md +1 -0
- data/docs/QueueConversationEventTopicSocialExpression.md +1 -0
- data/docs/QueueConversationEventTopicVideo.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicAfterCallWork.md +15 -0
- data/docs/QueueConversationSocialExpressionEventTopicCall.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicCallback.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicChat.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicCobrowse.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicEmail.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicMessage.md +2 -0
- data/docs/QueueConversationSocialExpressionEventTopicScreenshare.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicSocialExpression.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicVideo.md +1 -0
- data/docs/QueueConversationVideoEventTopicAfterCallWork.md +15 -0
- data/docs/QueueConversationVideoEventTopicCall.md +1 -0
- data/docs/QueueConversationVideoEventTopicCallback.md +1 -0
- data/docs/QueueConversationVideoEventTopicChat.md +1 -0
- data/docs/QueueConversationVideoEventTopicCobrowse.md +1 -0
- data/docs/QueueConversationVideoEventTopicEmail.md +1 -0
- data/docs/QueueConversationVideoEventTopicMessage.md +2 -0
- data/docs/QueueConversationVideoEventTopicScreenshare.md +1 -0
- data/docs/QueueConversationVideoEventTopicSocialExpression.md +1 -0
- data/docs/QueueConversationVideoEventTopicVideo.md +1 -0
- data/docs/Recording.md +1 -0
- data/docs/RecordingApi.md +2 -2
- data/docs/ReportingDataExportTopicDataExportNotification.md +1 -0
- data/docs/ReportingExportJobRequest.md +2 -0
- data/docs/ReportingExportJobResponse.md +4 -0
- data/docs/RoutingApi.md +14 -14
- data/docs/SCIMApi.md +92 -104
- data/docs/ScimConfigResourceType.md +2 -2
- data/docs/ScimGenesysUserExternalId.md +14 -0
- data/docs/ScimMetadata.md +2 -2
- data/docs/ScimUserExtensions.md +3 -2
- data/docs/ScimUserRole.md +1 -1
- data/docs/ScimUserRoutingLanguage.md +2 -2
- data/docs/ScimUserRoutingSkill.md +2 -2
- data/docs/ScimV2CreateUser.md +3 -3
- data/docs/ScimV2Group.md +1 -1
- data/docs/ScimV2SchemaAttribute.md +11 -11
- data/docs/ScimV2SchemaDefinition.md +5 -5
- data/docs/ScimV2SchemaListResponse.md +1 -1
- data/docs/ScimV2User.md +4 -4
- data/docs/Screenshare.md +1 -0
- data/docs/SearchApi.md +5 -2
- data/docs/SmsConfig.md +15 -0
- data/docs/SmsPhoneNumberRef.md +14 -0
- data/docs/SocialExpression.md +1 -0
- data/docs/SpeechTextAnalyticsApi.md +147 -0
- data/docs/StatEventFlowOutcomeTopicDatum.md +14 -0
- data/docs/StatEventFlowOutcomeTopicMetric.md +15 -0
- data/docs/StatEventFlowOutcomeTopicStatsNotification.md +14 -0
- data/docs/StatEventFlowTopicDatum.md +14 -0
- data/docs/StatEventFlowTopicMetric.md +15 -0
- data/docs/StatEventFlowTopicStatsNotification.md +14 -0
- data/docs/StatEventWrapUpCodeTopicDatum.md +14 -0
- data/docs/StatEventWrapUpCodeTopicMetric.md +15 -0
- data/docs/StatEventWrapUpCodeTopicStatsNotification.md +14 -0
- data/docs/SurveyForm.md +0 -2
- data/docs/TelephonyProvidersEdgeApi.md +6 -2
- data/docs/TextbotsApi.md +78 -0
- data/docs/TranscriptUrl.md +13 -0
- data/docs/UpdateCoachingAppointmentRequest.md +2 -1
- data/docs/UserRoutingLanguage.md +3 -3
- data/docs/UserRoutingLanguagePost.md +1 -1
- data/docs/UserRoutingSkill.md +1 -1
- data/docs/UserScheduleAdherence.md +1 -0
- data/docs/UserSearchRequest.md +2 -0
- data/docs/UsersApi.md +19 -6
- data/docs/Video.md +1 -0
- data/docs/ViewFilter.md +2 -0
- data/docs/VoicemailUserPolicy.md +1 -0
- data/docs/WemCoachingAppointmentTopicCoachingAppointmentNotification.md +1 -0
- data/docs/WfmBusinessUnitReference.md +14 -0
- data/docs/WfmHistoricalAdherenceResponse.md +1 -0
- data/docs/WfmHistoricalAdherenceResultWrapper.md +15 -0
- data/docs/WfmHistoricalDataUploadPurgeRequestStatusTopicHistoricalDataUploadPurgeRequestUpdate.md +13 -0
- data/docs/WfmHistoricalDataUploadRequestStatusTopicDateTime.md +16 -0
- data/docs/WfmHistoricalDataUploadRequestStatusTopicHistoricalDataUploadRequestUpdate.md +20 -0
- data/docs/WfmScheduleReference.md +16 -0
- data/docs/WfmUserScheduleAdherenceUpdatedMuTopicUriReference.md +14 -0
- data/docs/WfmUserScheduleAdherenceUpdatedMuTopicUserScheduleAdherenceUpdate.md +1 -0
- data/docs/WfmUserScheduleAdherenceUpdatedTeamTopicQueueReference.md +13 -0
- data/docs/WfmUserScheduleAdherenceUpdatedTeamTopicUriReference.md +14 -0
- data/docs/WfmUserScheduleAdherenceUpdatedTeamTopicUserReference.md +13 -0
- data/docs/WfmUserScheduleAdherenceUpdatedTeamTopicUserScheduleAdherenceUpdate.md +28 -0
- data/docs/WfmUserScheduleAdherenceUpdatedTopicUriReference.md +14 -0
- data/docs/WfmUserScheduleAdherenceUpdatedTopicUserScheduleAdherenceUpdate.md +1 -0
- data/lib/purecloudplatformclientv2.rb +91 -0
- data/lib/purecloudplatformclientv2/api/analytics_api.rb +67 -2
- data/lib/purecloudplatformclientv2/api/architect_api.rb +15 -6
- data/lib/purecloudplatformclientv2/api/audit_api.rb +129 -0
- data/lib/purecloudplatformclientv2/api/coaching_api.rb +155 -9
- data/lib/purecloudplatformclientv2/api/conversations_api.rb +79 -4
- data/lib/purecloudplatformclientv2/api/external_contacts_api.rb +305 -13
- data/lib/purecloudplatformclientv2/api/journey_api.rb +92 -0
- data/lib/purecloudplatformclientv2/api/language_understanding_api.rb +191 -32
- data/lib/purecloudplatformclientv2/api/outbound_api.rb +1215 -155
- data/lib/purecloudplatformclientv2/api/presence_api.rb +213 -8
- data/lib/purecloudplatformclientv2/api/recording_api.rb +3 -3
- data/lib/purecloudplatformclientv2/api/routing_api.rb +2 -2
- data/lib/purecloudplatformclientv2/api/scim_api.rb +74 -74
- data/lib/purecloudplatformclientv2/api/search_api.rb +13 -0
- data/lib/purecloudplatformclientv2/api/speech_text_analytics_api.rb +167 -0
- data/lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb +18 -0
- data/lib/purecloudplatformclientv2/api/textbots_api.rb +92 -0
- data/lib/purecloudplatformclientv2/api/users_api.rb +78 -0
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/acw_settings.rb +2 -2
- data/lib/purecloudplatformclientv2/models/after_call_work.rb +267 -0
- data/lib/purecloudplatformclientv2/models/amazon_lex_request.rb +232 -0
- data/lib/purecloudplatformclientv2/models/analytics_proposed_agent.rb +228 -0
- data/lib/purecloudplatformclientv2/models/analytics_session.rb +178 -4
- data/lib/purecloudplatformclientv2/models/array_node.rb +54 -54
- data/lib/purecloudplatformclientv2/models/audit_log_message.rb +6 -6
- data/lib/purecloudplatformclientv2/models/audit_query_entity.rb +2 -2
- data/lib/purecloudplatformclientv2/models/audit_query_execution_status_response.rb +2 -2
- data/lib/purecloudplatformclientv2/models/audit_query_request.rb +2 -2
- data/lib/purecloudplatformclientv2/models/audit_query_service.rb +2 -2
- data/lib/purecloudplatformclientv2/models/audit_realtime_query_request.rb +360 -0
- data/lib/purecloudplatformclientv2/models/audit_realtime_query_results_response.rb +303 -0
- data/lib/purecloudplatformclientv2/models/available_topic.rb +32 -4
- data/lib/purecloudplatformclientv2/models/biography.rb +32 -4
- data/lib/purecloudplatformclientv2/models/bu_agent_schedules_query_response.rb +30 -4
- data/lib/purecloudplatformclientv2/models/button_component.rb +281 -0
- data/lib/purecloudplatformclientv2/models/call.rb +30 -4
- data/lib/purecloudplatformclientv2/models/call_basic.rb +30 -4
- data/lib/purecloudplatformclientv2/models/callback.rb +30 -4
- data/lib/purecloudplatformclientv2/models/callback_basic.rb +30 -4
- data/lib/purecloudplatformclientv2/models/coaching_appointment_aggregate_request.rb +294 -0
- data/lib/purecloudplatformclientv2/models/coaching_appointment_aggregate_response.rb +204 -0
- data/lib/purecloudplatformclientv2/models/coaching_appointment_response.rb +27 -1
- data/lib/purecloudplatformclientv2/models/coaching_notification.rb +1 -1
- data/lib/purecloudplatformclientv2/models/cobrowsesession.rb +30 -4
- data/lib/purecloudplatformclientv2/models/common_campaign.rb +320 -0
- data/lib/purecloudplatformclientv2/models/common_campaign_division_view.rb +320 -0
- data/lib/purecloudplatformclientv2/models/common_campaign_division_view_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/common_campaign_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/contact.rb +29 -4
- data/lib/purecloudplatformclientv2/models/content_actions.rb +309 -0
- data/lib/purecloudplatformclientv2/models/content_attachment.rb +378 -0
- data/lib/purecloudplatformclientv2/models/content_generic.rb +361 -0
- data/lib/purecloudplatformclientv2/models/content_list.rb +375 -0
- data/lib/purecloudplatformclientv2/models/content_location.rb +307 -0
- data/lib/purecloudplatformclientv2/models/content_notification_template.rb +312 -0
- data/lib/purecloudplatformclientv2/models/content_quick_reply.rb +300 -0
- data/lib/purecloudplatformclientv2/models/conversation_aggregate_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/conversation_association.rb +1 -1
- data/lib/purecloudplatformclientv2/models/conversation_chat.rb +30 -4
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_after_call_work.rb +265 -0
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_call.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_callback.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_chat.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_cobrowse.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_email.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_message.rb +53 -3
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_screenshare.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_social_expression.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_video.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_message_event_topic_message_media_participant.rb +2 -2
- data/lib/purecloudplatformclientv2/models/conversation_metrics.rb +254 -0
- data/lib/purecloudplatformclientv2/models/create_coaching_appointment_request.rb +1 -1
- data/lib/purecloudplatformclientv2/models/create_outbound_messaging_conversation_request.rb +2 -2
- data/lib/purecloudplatformclientv2/models/cursor_contact_listing.rb +278 -0
- data/lib/purecloudplatformclientv2/models/cursor_note_listing.rb +278 -0
- data/lib/purecloudplatformclientv2/models/cursor_organization_listing.rb +278 -0
- data/lib/purecloudplatformclientv2/models/cursor_relationship_listing.rb +278 -0
- data/lib/purecloudplatformclientv2/models/dependency.rb +2 -2
- data/lib/purecloudplatformclientv2/models/dependency_object.rb +2 -2
- data/lib/purecloudplatformclientv2/models/edge_group.rb +27 -1
- data/lib/purecloudplatformclientv2/models/education.rb +304 -0
- data/lib/purecloudplatformclientv2/models/email.rb +30 -4
- data/lib/purecloudplatformclientv2/models/entity_listing.rb +4 -104
- data/lib/purecloudplatformclientv2/models/event_message.rb +2 -2
- data/lib/purecloudplatformclientv2/models/external_organization_trustor_link.rb +8 -34
- data/lib/purecloudplatformclientv2/models/facebook_integration_update_request.rb +228 -0
- data/lib/purecloudplatformclientv2/models/flow_aggregate_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/google_dialogflow_custom_settings.rb +202 -0
- data/lib/purecloudplatformclientv2/models/historical_adherence_actuals.rb +268 -0
- data/lib/purecloudplatformclientv2/models/historical_adherence_day_metrics.rb +462 -0
- data/lib/purecloudplatformclientv2/models/historical_adherence_exception_info.rb +466 -0
- data/lib/purecloudplatformclientv2/models/historical_adherence_query_result.rb +430 -0
- data/lib/purecloudplatformclientv2/models/intent_feedback.rb +2 -2
- data/lib/purecloudplatformclientv2/models/ip_address_range.rb +2 -2
- data/lib/purecloudplatformclientv2/models/journey_aggregate_data_container.rb +231 -0
- data/lib/purecloudplatformclientv2/models/journey_aggregate_query_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/journey_aggregate_query_filter.rb +277 -0
- data/lib/purecloudplatformclientv2/models/journey_aggregate_query_predicate.rb +348 -0
- data/lib/purecloudplatformclientv2/models/journey_aggregate_query_response.rb +203 -0
- data/lib/purecloudplatformclientv2/models/journey_aggregation_query.rb +435 -0
- data/lib/purecloudplatformclientv2/models/journey_aggregation_view.rb +323 -0
- data/lib/purecloudplatformclientv2/models/json_node.rb +54 -54
- data/lib/purecloudplatformclientv2/models/knowledge_search_request.rb +0 -15
- data/lib/purecloudplatformclientv2/models/library.rb +2 -2
- data/lib/purecloudplatformclientv2/models/list_item_component.rb +373 -0
- data/lib/purecloudplatformclientv2/models/message.rb +32 -6
- data/lib/purecloudplatformclientv2/models/message_content.rb +378 -0
- data/lib/purecloudplatformclientv2/models/message_data.rb +2 -2
- data/lib/purecloudplatformclientv2/models/message_media_participant.rb +2 -2
- data/lib/purecloudplatformclientv2/models/messaging_campaign.rb +621 -0
- data/lib/purecloudplatformclientv2/models/messaging_campaign_division_view.rb +279 -0
- data/lib/purecloudplatformclientv2/models/messaging_campaign_division_view_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/messaging_campaign_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/messaging_integration.rb +2 -2
- data/lib/purecloudplatformclientv2/models/messaging_sticker.rb +2 -2
- data/lib/purecloudplatformclientv2/models/nlu_domain_version.rb +32 -1
- data/lib/purecloudplatformclientv2/models/notification_template_body.rb +236 -0
- data/lib/purecloudplatformclientv2/models/notification_template_footer.rb +203 -0
- data/lib/purecloudplatformclientv2/models/notification_template_header.rb +302 -0
- data/lib/purecloudplatformclientv2/models/notification_template_parameter.rb +234 -0
- data/lib/purecloudplatformclientv2/models/o_auth_client.rb +67 -1
- data/lib/purecloudplatformclientv2/models/o_auth_client_listing.rb +67 -1
- data/lib/purecloudplatformclientv2/models/o_auth_client_request.rb +70 -4
- data/lib/purecloudplatformclientv2/models/observation_value.rb +70 -2
- data/lib/purecloudplatformclientv2/models/org_o_auth_client.rb +67 -1
- data/lib/purecloudplatformclientv2/models/participant.rb +2 -2
- data/lib/purecloudplatformclientv2/models/participant_basic.rb +2 -2
- data/lib/purecloudplatformclientv2/models/permissions.rb +1 -52
- data/lib/purecloudplatformclientv2/models/phone_capabilities.rb +29 -4
- data/lib/purecloudplatformclientv2/models/post_text_message.rb +275 -0
- data/lib/purecloudplatformclientv2/models/post_text_request.rb +482 -0
- data/lib/purecloudplatformclientv2/models/post_text_response.rb +413 -0
- data/lib/purecloudplatformclientv2/models/presence_expand.rb +309 -0
- data/lib/purecloudplatformclientv2/models/query_request_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/query_request_filter.rb +254 -0
- data/lib/purecloudplatformclientv2/models/query_request_predicate.rb +252 -0
- data/lib/purecloudplatformclientv2/models/query_response_data.rb +230 -0
- data/lib/purecloudplatformclientv2/models/query_response_grouped_data.rb +232 -0
- data/lib/purecloudplatformclientv2/models/query_response_metric.rb +242 -0
- data/lib/purecloudplatformclientv2/models/query_response_stats.rb +202 -0
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_after_call_work.rb +265 -0
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_call.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_callback.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_chat.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_cobrowse.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_email.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_message.rb +53 -3
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_screenshare.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_social_expression.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_video.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_message_event_topic_message_media_participant.rb +2 -2
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_after_call_work.rb +265 -0
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_call.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_callback.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_chat.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_cobrowse.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_email.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_message.rb +53 -3
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_screenshare.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_social_expression.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_video.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_after_call_work.rb +265 -0
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_call.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_callback.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_chat.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_cobrowse.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_email.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_message.rb +53 -3
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_screenshare.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_social_expression.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_video.rb +26 -1
- data/lib/purecloudplatformclientv2/models/recipient.rb +2 -2
- data/lib/purecloudplatformclientv2/models/recording.rb +41 -1
- data/lib/purecloudplatformclientv2/models/reporting_data_export_topic_data_export_notification.rb +26 -1
- data/lib/purecloudplatformclientv2/models/reporting_export_job_request.rb +53 -1
- data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +109 -1
- data/lib/purecloudplatformclientv2/models/response.rb +2 -2
- data/lib/purecloudplatformclientv2/models/schedule_generation_message.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_config_resource_type.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_genesys_user_external_id.rb +229 -0
- data/lib/purecloudplatformclientv2/models/scim_metadata.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_phone_number.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_user_extensions.rb +35 -7
- data/lib/purecloudplatformclientv2/models/scim_user_role.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_user_routing_language.rb +3 -3
- data/lib/purecloudplatformclientv2/models/scim_user_routing_skill.rb +3 -3
- data/lib/purecloudplatformclientv2/models/scim_v2_create_user.rb +3 -2
- data/lib/purecloudplatformclientv2/models/scim_v2_enterprise_user.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_v2_group.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_v2_schema_attribute.rb +12 -12
- data/lib/purecloudplatformclientv2/models/scim_v2_schema_definition.rb +6 -6
- data/lib/purecloudplatformclientv2/models/scim_v2_schema_list_response.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_v2_user.rb +4 -3
- data/lib/purecloudplatformclientv2/models/screenshare.rb +30 -4
- data/lib/purecloudplatformclientv2/models/segment_detail_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/send_agentless_outbound_message_request.rb +2 -2
- data/lib/purecloudplatformclientv2/models/send_agentless_outbound_message_response.rb +2 -2
- data/lib/purecloudplatformclientv2/models/sms_config.rb +269 -0
- data/lib/purecloudplatformclientv2/models/sms_phone_number_ref.rb +232 -0
- data/lib/purecloudplatformclientv2/models/social_expression.rb +30 -4
- data/lib/purecloudplatformclientv2/models/stat_event_flow_outcome_topic_datum.rb +228 -0
- data/lib/purecloudplatformclientv2/models/stat_event_flow_outcome_topic_metric.rb +253 -0
- data/lib/purecloudplatformclientv2/models/stat_event_flow_outcome_topic_stats_notification.rb +230 -0
- data/lib/purecloudplatformclientv2/models/stat_event_flow_topic_datum.rb +228 -0
- data/lib/purecloudplatformclientv2/models/stat_event_flow_topic_metric.rb +253 -0
- data/lib/purecloudplatformclientv2/models/stat_event_flow_topic_stats_notification.rb +230 -0
- data/lib/purecloudplatformclientv2/models/stat_event_wrap_up_code_topic_datum.rb +228 -0
- data/lib/purecloudplatformclientv2/models/stat_event_wrap_up_code_topic_metric.rb +253 -0
- data/lib/purecloudplatformclientv2/models/stat_event_wrap_up_code_topic_stats_notification.rb +230 -0
- data/lib/purecloudplatformclientv2/models/survey_form.rb +1 -53
- data/lib/purecloudplatformclientv2/models/transcript_url.rb +202 -0
- data/lib/purecloudplatformclientv2/models/update_coaching_appointment_request.rb +45 -5
- data/lib/purecloudplatformclientv2/models/user_routing_language.rb +4 -4
- data/lib/purecloudplatformclientv2/models/user_routing_language_post.rb +1 -1
- data/lib/purecloudplatformclientv2/models/user_routing_skill.rb +1 -1
- data/lib/purecloudplatformclientv2/models/user_schedule_adherence.rb +27 -1
- data/lib/purecloudplatformclientv2/models/user_search_request.rb +70 -4
- data/lib/purecloudplatformclientv2/models/video.rb +30 -4
- data/lib/purecloudplatformclientv2/models/view_filter.rb +60 -4
- data/lib/purecloudplatformclientv2/models/voicemail_user_policy.rb +30 -4
- data/lib/purecloudplatformclientv2/models/wem_coaching_appointment_topic_coaching_appointment_notification.rb +33 -8
- data/lib/purecloudplatformclientv2/models/wfm_business_unit_reference.rb +233 -0
- data/lib/purecloudplatformclientv2/models/wfm_historical_adherence_response.rb +27 -1
- data/lib/purecloudplatformclientv2/models/wfm_historical_adherence_result_wrapper.rb +258 -0
- data/lib/purecloudplatformclientv2/models/wfm_historical_data_upload_purge_request_status_topic_historical_data_upload_purge_request_update.rb +215 -0
- data/lib/purecloudplatformclientv2/models/wfm_historical_data_upload_request_status_topic_date_time.rb +276 -0
- data/lib/purecloudplatformclientv2/models/wfm_historical_data_upload_request_status_topic_historical_data_upload_request_update.rb +390 -0
- data/lib/purecloudplatformclientv2/models/wfm_schedule_reference.rb +295 -0
- data/lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_mu_topic_uri_reference.rb +226 -0
- data/lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_mu_topic_user_schedule_adherence_update.rb +26 -1
- data/lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_team_topic_queue_reference.rb +201 -0
- data/lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_team_topic_uri_reference.rb +226 -0
- data/lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_team_topic_user_reference.rb +201 -0
- data/lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_team_topic_user_schedule_adherence_update.rb +606 -0
- data/lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_topic_uri_reference.rb +226 -0
- data/lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_topic_user_schedule_adherence_update.rb +26 -1
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +185 -3
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: CoachingAppointmentAggregateRequest
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::CoachingAppointmentAggregateRequest
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **interval** | **String** | Interval to aggregate across. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | |
|
|
11
|
+
| **metrics** | **Array<String>** | A list of metrics to aggregate. If omitted, all metrics are returned. | [optional] |
|
|
12
|
+
| **group_by** | **Array<String>** | An optional list of items by which to group the result data. | [optional] |
|
|
13
|
+
| **filter** | [**QueryRequestFilter**](QueryRequestFilter.html) | The filter applied to the data | |
|
|
14
|
+
{: class="table table-striped"}
|
|
15
|
+
|
|
16
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: CoachingAppointmentAggregateResponse
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::CoachingAppointmentAggregateResponse
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **results** | [**Array<QueryResponseGroupedData>**](QueryResponseGroupedData.html) | The results of the query | [optional] |
|
|
11
|
+
{: class="table table-striped"}
|
|
12
|
+
|
|
13
|
+
|
|
@@ -21,6 +21,7 @@ title: CoachingAppointmentResponse
|
|
|
21
21
|
| **date_modified** | **DateTime** | The date/time the coaching appointment was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
22
22
|
| **conversations** | [**Array<ConversationReference>**](ConversationReference.html) | The list of conversations associated with coaching appointment. | [optional] |
|
|
23
23
|
| **documents** | [**Array<DocumentReference>**](DocumentReference.html) | The list of documents associated with coaching appointment. | [optional] |
|
|
24
|
+
| **is_overdue** | **BOOLEAN** | Whether the appointment is overdue. | [optional] |
|
|
24
25
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
25
26
|
{: class="table table-striped"}
|
|
26
27
|
|
|
@@ -16,7 +16,7 @@ title: CoachingNotification
|
|
|
16
16
|
| **length_in_minutes** | **Integer** | The duration of the appointment on this notification | [optional] |
|
|
17
17
|
| **status** | **String** | The status of the appointment for this notification | [optional] |
|
|
18
18
|
| **user** | [**UserReference**](UserReference.html) | The user of this notification | [optional] |
|
|
19
|
-
| **appointment** | [**
|
|
19
|
+
| **appointment** | [**CoachingAppointmentResponse**](CoachingAppointmentResponse.html) | The appointment | [optional] |
|
|
20
20
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
21
21
|
{: class="table table-striped"}
|
|
22
22
|
|
data/docs/Cobrowsesession.md
CHANGED
|
@@ -23,6 +23,7 @@ title: Cobrowsesession
|
|
|
23
23
|
| **peer_id** | **String** | The id of the peer communication corresponding to a matching leg for this communication. | [optional] |
|
|
24
24
|
| **segments** | [**Array<Segment>**](Segment.html) | The time line of the participant's call, divided into activity segments. | [optional] |
|
|
25
25
|
| **wrapup** | [**Wrapup**](Wrapup.html) | Call wrap up or disposition data. | [optional] |
|
|
26
|
+
| **after_call_work** | [**AfterCallWork**](AfterCallWork.html) | After-call work for the communication. | [optional] |
|
|
26
27
|
{: class="table table-striped"}
|
|
27
28
|
|
|
28
29
|
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: CommonCampaign
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::CommonCampaign
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
|
+
| **name** | **String** | The name of the Campaign. | [optional] |
|
|
12
|
+
| **division** | [**Division**](Division.html) | The division to which this entity belongs. | [optional] |
|
|
13
|
+
| **media_type** | **String** | The media type used for this campaign. | [optional] |
|
|
14
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
15
|
+
{: class="table table-striped"}
|
|
16
|
+
|
|
17
|
+
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: CommonCampaignDivisionView
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::CommonCampaignDivisionView
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
|
+
| **name** | **String** | The name of the Campaign. | [optional] |
|
|
12
|
+
| **division** | [**Division**](Division.html) | The division to which this entity belongs. | [optional] |
|
|
13
|
+
| **media_type** | **String** | The media type used for this campaign. | [optional] |
|
|
14
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
15
|
+
{: class="table table-striped"}
|
|
16
|
+
|
|
17
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: CommonCampaignDivisionViewEntityListing
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::CommonCampaignDivisionViewEntityListing
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **entities** | [**Array<CommonCampaignDivisionView>**](CommonCampaignDivisionView.html) | | [optional] |
|
|
11
|
+
| **page_size** | **Integer** | | [optional] |
|
|
12
|
+
| **page_number** | **Integer** | | [optional] |
|
|
13
|
+
| **total** | **Integer** | | [optional] |
|
|
14
|
+
| **first_uri** | **String** | | [optional] |
|
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
|
19
|
+
| **page_count** | **Integer** | | [optional] |
|
|
20
|
+
{: class="table table-striped"}
|
|
21
|
+
|
|
22
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: CommonCampaignEntityListing
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::CommonCampaignEntityListing
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **entities** | [**Array<CommonCampaign>**](CommonCampaign.html) | | [optional] |
|
|
11
|
+
| **page_size** | **Integer** | | [optional] |
|
|
12
|
+
| **page_number** | **Integer** | | [optional] |
|
|
13
|
+
| **total** | **Integer** | | [optional] |
|
|
14
|
+
| **first_uri** | **String** | | [optional] |
|
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
|
19
|
+
| **page_count** | **Integer** | | [optional] |
|
|
20
|
+
{: class="table table-striped"}
|
|
21
|
+
|
|
22
|
+
|
data/docs/Contact.md
CHANGED
|
@@ -12,6 +12,7 @@ title: Contact
|
|
|
12
12
|
| **media_type** | **String** | | [optional] |
|
|
13
13
|
| **type** | **String** | | [optional] |
|
|
14
14
|
| **extension** | **String** | Use internal extension instead of address. Mutually exclusive with the address field. | [optional] |
|
|
15
|
+
| **country_code** | **String** | | [optional] |
|
|
15
16
|
{: class="table table-striped"}
|
|
16
17
|
|
|
17
18
|
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ContentActions
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::ContentActions
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **url** | **String** | A URL for a web page to redirect the user to | [optional] |
|
|
11
|
+
| **url_target** | **String** | The target window or tab within the URL's web page. If empty will open a blank page or tab. | [optional] |
|
|
12
|
+
| **textback** | **String** | Text to be sent back in reply when a list item is selected | [optional] |
|
|
13
|
+
| **command_name** | **String** | Execute an organization's specific command | [optional] |
|
|
14
|
+
| **context** | **Hash<String, Object>** | Additional context for the command | [optional] |
|
|
15
|
+
{: class="table table-striped"}
|
|
16
|
+
|
|
17
|
+
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ContentAttachment
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::ContentAttachment
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **id** | **String** | Vendor specific ID for media. For example, a LINE sticker ID | [optional] |
|
|
11
|
+
| **media_type** | **String** | The type of media this instance represents | |
|
|
12
|
+
| **url** | **String** | Content element url | [optional] |
|
|
13
|
+
| **mime** | **String** | Content mime type from https://www.iana.org/assignments/media-types/media-types.xhtml | [optional] |
|
|
14
|
+
| **text** | **String** | Text message associated with media element: e.g. caption in case of image. | [optional] |
|
|
15
|
+
| **sha256** | **String** | Secure hash of the media content | [optional] |
|
|
16
|
+
| **filename** | **String** | Suggested file name for media file | [optional] |
|
|
17
|
+
{: class="table table-striped"}
|
|
18
|
+
|
|
19
|
+
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ContentGeneric
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::ContentGeneric
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **id** | **String** | An ID assigned to this rich message content. Each instance inside the content array has a unique ID. | [optional] |
|
|
11
|
+
| **title** | **String** | Text to show in the title row | [optional] |
|
|
12
|
+
| **description** | **String** | Text to show in the description row. This is immediately below the title | [optional] |
|
|
13
|
+
| **image** | **String** | Path or URI to an image file | [optional] |
|
|
14
|
+
| **video** | **String** | Path or URI to a video file | [optional] |
|
|
15
|
+
| **actions** | [**ContentActions**](ContentActions.html) | User actions available on the content. All actions are optional and all actions are executed simultaneously. | [optional] |
|
|
16
|
+
| **components** | [**Array<ButtonComponent>**](ButtonComponent.html) | An array of component objects | [optional] |
|
|
17
|
+
{: class="table table-striped"}
|
|
18
|
+
|
|
19
|
+
|
data/docs/ContentList.md
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ContentList
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::ContentList
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **id** | **String** | An ID assigned to this rich message content. Each instance inside the content array has a unique ID. | [optional] |
|
|
11
|
+
| **list_type** | **String** | The type of list this instance represents | [optional] |
|
|
12
|
+
| **title** | **String** | Text to show in the title row | [optional] |
|
|
13
|
+
| **description** | **String** | Text to show in the description row. This is immediately below the title | [optional] |
|
|
14
|
+
| **submit_label** | **String** | Label for Submit button | [optional] |
|
|
15
|
+
| **actions** | [**ContentActions**](ContentActions.html) | User actions available on the content. All actions are optional and all actions are executed simultaneously. | [optional] |
|
|
16
|
+
| **components** | [**Array<ListItemComponent>**](ListItemComponent.html) | An array of component objects | [optional] |
|
|
17
|
+
{: class="table table-striped"}
|
|
18
|
+
|
|
19
|
+
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ContentLocation
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::ContentLocation
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **url** | **String** | Location map url | [optional] |
|
|
11
|
+
| **address** | **String** | Location postal address | [optional] |
|
|
12
|
+
| **text** | **String** | Location name | [optional] |
|
|
13
|
+
| **latitude** | **Float** | Latitude of the location | [optional] |
|
|
14
|
+
| **longitude** | **Float** | Longitude of the location | [optional] |
|
|
15
|
+
{: class="table table-striped"}
|
|
16
|
+
|
|
17
|
+
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ContentNotificationTemplate
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::ContentNotificationTemplate
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **id** | **String** | The messaging channel template id. For WhatsApp, 'namespace@name' | [optional] |
|
|
11
|
+
| **language** | **String** | Template language | [optional] |
|
|
12
|
+
| **header** | [**NotificationTemplateHeader**](NotificationTemplateHeader.html) | Template header object | [optional] |
|
|
13
|
+
| **body** | [**NotificationTemplateBody**](NotificationTemplateBody.html) | Template body object | |
|
|
14
|
+
| **footer** | [**NotificationTemplateFooter**](NotificationTemplateFooter.html) | Template footer object | [optional] |
|
|
15
|
+
{: class="table table-striped"}
|
|
16
|
+
|
|
17
|
+
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ContentQuickReply
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::ContentQuickReply
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **id** | **String** | An ID assigned to the quick reply. Each object inside the content array has a unique ID. | [optional] |
|
|
11
|
+
| **text** | **String** | Text to show inside the quick reply. This is also used as the response text after clicking on the quick reply. | |
|
|
12
|
+
| **image** | **String** | Image associated with quick reply | [optional] |
|
|
13
|
+
| **action** | **String** | Specifies the type of action that is triggered upon clicking the quick reply. Currently, the only supported action is \"Message\" which sends a message using the quick reply text. | [optional] |
|
|
14
|
+
{: class="table table-striped"}
|
|
15
|
+
|
|
16
|
+
|
|
@@ -7,7 +7,7 @@ title: ConversationAssociation
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **external_contact_id** | **String** |
|
|
10
|
+
| **external_contact_id** | **String** | An external contact ID. If not supplied, implies the conversation should be disassociated with any external contact. | [optional] |
|
|
11
11
|
| **conversation_id** | **String** | Conversation ID | |
|
|
12
12
|
| **communication_id** | **String** | Communication ID | |
|
|
13
13
|
| **media_type** | **String** | Media type | |
|
data/docs/ConversationChat.md
CHANGED
|
@@ -25,6 +25,7 @@ title: ConversationChat
|
|
|
25
25
|
| **avatar_image_url** | **String** | If available, the URI to the avatar image of this communication. | [optional] |
|
|
26
26
|
| **journey_context** | [**JourneyContext**](JourneyContext.html) | A subset of the Journey System's data relevant to a part of a conversation (for external linkage and internal usage/context). | [optional] |
|
|
27
27
|
| **wrapup** | [**Wrapup**](Wrapup.html) | Call wrap up or disposition data. | [optional] |
|
|
28
|
+
| **after_call_work** | [**AfterCallWork**](AfterCallWork.html) | After-call work for the communication. | [optional] |
|
|
28
29
|
{: class="table table-striped"}
|
|
29
30
|
|
|
30
31
|
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ConversationEventTopicAfterCallWork
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::ConversationEventTopicAfterCallWork
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **state** | **String** | | [optional] |
|
|
11
|
+
| **start_time** | **DateTime** | | [optional] |
|
|
12
|
+
| **end_time** | **DateTime** | | [optional] |
|
|
13
|
+
{: class="table table-striped"}
|
|
14
|
+
|
|
15
|
+
|
|
@@ -30,6 +30,7 @@ title: ConversationEventTopicCall
|
|
|
30
30
|
| **fax_status** | [**ConversationEventTopicFaxStatus**](ConversationEventTopicFaxStatus.html) | | [optional] |
|
|
31
31
|
| **uui_data** | **String** | | [optional] |
|
|
32
32
|
| **wrapup** | [**ConversationEventTopicWrapup**](ConversationEventTopicWrapup.html) | | [optional] |
|
|
33
|
+
| **after_call_work** | [**ConversationEventTopicAfterCallWork**](ConversationEventTopicAfterCallWork.html) | | [optional] |
|
|
33
34
|
| **additional_properties** | **Object** | | [optional] |
|
|
34
35
|
{: class="table table-striped"}
|
|
35
36
|
|
|
@@ -28,6 +28,7 @@ title: ConversationEventTopicCallback
|
|
|
28
28
|
| **callback_scheduled_time** | **DateTime** | | [optional] |
|
|
29
29
|
| **automated_callback_config_id** | **String** | | [optional] |
|
|
30
30
|
| **wrapup** | [**ConversationEventTopicWrapup**](ConversationEventTopicWrapup.html) | | [optional] |
|
|
31
|
+
| **after_call_work** | [**ConversationEventTopicAfterCallWork**](ConversationEventTopicAfterCallWork.html) | | [optional] |
|
|
31
32
|
| **additional_properties** | **Object** | | [optional] |
|
|
32
33
|
{: class="table table-striped"}
|
|
33
34
|
|
|
@@ -21,6 +21,7 @@ title: ConversationEventTopicChat
|
|
|
21
21
|
| **disconnected_time** | **DateTime** | | [optional] |
|
|
22
22
|
| **journey_context** | [**ConversationEventTopicJourneyContext**](ConversationEventTopicJourneyContext.html) | | [optional] |
|
|
23
23
|
| **wrapup** | [**ConversationEventTopicWrapup**](ConversationEventTopicWrapup.html) | | [optional] |
|
|
24
|
+
| **after_call_work** | [**ConversationEventTopicAfterCallWork**](ConversationEventTopicAfterCallWork.html) | | [optional] |
|
|
24
25
|
| **additional_properties** | **Object** | | [optional] |
|
|
25
26
|
{: class="table table-striped"}
|
|
26
27
|
|
|
@@ -23,6 +23,7 @@ title: ConversationEventTopicCobrowse
|
|
|
23
23
|
| **connected_time** | **DateTime** | | [optional] |
|
|
24
24
|
| **disconnected_time** | **DateTime** | | [optional] |
|
|
25
25
|
| **wrapup** | [**ConversationEventTopicWrapup**](ConversationEventTopicWrapup.html) | | [optional] |
|
|
26
|
+
| **after_call_work** | [**ConversationEventTopicAfterCallWork**](ConversationEventTopicAfterCallWork.html) | | [optional] |
|
|
26
27
|
| **additional_properties** | **Object** | | [optional] |
|
|
27
28
|
{: class="table table-striped"}
|
|
28
29
|
|
|
@@ -26,6 +26,7 @@ title: ConversationEventTopicEmail
|
|
|
26
26
|
| **draft_attachments** | [**Array<ConversationEventTopicAttachment>**](ConversationEventTopicAttachment.html) | | [optional] |
|
|
27
27
|
| **spam** | **BOOLEAN** | | [optional] |
|
|
28
28
|
| **wrapup** | [**ConversationEventTopicWrapup**](ConversationEventTopicWrapup.html) | | [optional] |
|
|
29
|
+
| **after_call_work** | [**ConversationEventTopicAfterCallWork**](ConversationEventTopicAfterCallWork.html) | | [optional] |
|
|
29
30
|
| **additional_properties** | **Object** | | [optional] |
|
|
30
31
|
{: class="table table-striped"}
|
|
31
32
|
|
|
@@ -10,6 +10,7 @@ title: ConversationEventTopicMessage
|
|
|
10
10
|
| **id** | **String** | | [optional] |
|
|
11
11
|
| **state** | **String** | | [optional] |
|
|
12
12
|
| **held** | **BOOLEAN** | | [optional] |
|
|
13
|
+
| **error_info** | [**ConversationEventTopicErrorDetails**](ConversationEventTopicErrorDetails.html) | | [optional] |
|
|
13
14
|
| **provider** | **String** | | [optional] |
|
|
14
15
|
| **script_id** | **String** | | [optional] |
|
|
15
16
|
| **peer_id** | **String** | | [optional] |
|
|
@@ -25,6 +26,7 @@ title: ConversationEventTopicMessage
|
|
|
25
26
|
| **recipient_country** | **String** | | [optional] |
|
|
26
27
|
| **recipient_type** | **String** | | [optional] |
|
|
27
28
|
| **wrapup** | [**ConversationEventTopicWrapup**](ConversationEventTopicWrapup.html) | | [optional] |
|
|
29
|
+
| **after_call_work** | [**ConversationEventTopicAfterCallWork**](ConversationEventTopicAfterCallWork.html) | | [optional] |
|
|
28
30
|
| **additional_properties** | **Object** | | [optional] |
|
|
29
31
|
{: class="table table-striped"}
|
|
30
32
|
|
|
@@ -19,6 +19,7 @@ title: ConversationEventTopicScreenshare
|
|
|
19
19
|
| **connected_time** | **DateTime** | | [optional] |
|
|
20
20
|
| **disconnected_time** | **DateTime** | | [optional] |
|
|
21
21
|
| **wrapup** | [**ConversationEventTopicWrapup**](ConversationEventTopicWrapup.html) | | [optional] |
|
|
22
|
+
| **after_call_work** | [**ConversationEventTopicAfterCallWork**](ConversationEventTopicAfterCallWork.html) | | [optional] |
|
|
22
23
|
| **additional_properties** | **Object** | | [optional] |
|
|
23
24
|
{: class="table table-striped"}
|
|
24
25
|
|
|
@@ -23,6 +23,7 @@ title: ConversationEventTopicSocialExpression
|
|
|
23
23
|
| **connected_time** | **DateTime** | | [optional] |
|
|
24
24
|
| **disconnected_time** | **DateTime** | | [optional] |
|
|
25
25
|
| **wrapup** | [**ConversationEventTopicWrapup**](ConversationEventTopicWrapup.html) | | [optional] |
|
|
26
|
+
| **after_call_work** | [**ConversationEventTopicAfterCallWork**](ConversationEventTopicAfterCallWork.html) | | [optional] |
|
|
26
27
|
| **additional_properties** | **Object** | | [optional] |
|
|
27
28
|
{: class="table table-striped"}
|
|
28
29
|
|
|
@@ -22,6 +22,7 @@ title: ConversationEventTopicVideo
|
|
|
22
22
|
| **disconnected_time** | **DateTime** | | [optional] |
|
|
23
23
|
| **msids** | **Array<String>** | | [optional] |
|
|
24
24
|
| **wrapup** | [**ConversationEventTopicWrapup**](ConversationEventTopicWrapup.html) | | [optional] |
|
|
25
|
+
| **after_call_work** | [**ConversationEventTopicAfterCallWork**](ConversationEventTopicAfterCallWork.html) | | [optional] |
|
|
25
26
|
| **additional_properties** | **Object** | | [optional] |
|
|
26
27
|
{: class="table table-striped"}
|
|
27
28
|
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ConversationMetrics
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::ConversationMetrics
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **conversation** | [**AddressableEntityRef**](AddressableEntityRef.html) | The Conversation Reference | [optional] |
|
|
11
|
+
| **sentiment_score** | **Float** | The Sentiment Score | [optional] |
|
|
12
|
+
| **sentiment_trend** | **Float** | The Sentiment Trend | [optional] |
|
|
13
|
+
{: class="table table-striped"}
|
|
14
|
+
|
|
15
|
+
|
data/docs/ConversationsApi.md
CHANGED
|
@@ -98,12 +98,13 @@ Method | Description
|
|
|
98
98
|
[**patch_conversations_message_participant**](ConversationsApi.html#patch_conversations_message_participant) | Update conversation participant
|
|
99
99
|
[**patch_conversations_message_participant_attributes**](ConversationsApi.html#patch_conversations_message_participant_attributes) | Update the attributes on a conversation participant.
|
|
100
100
|
[**patch_conversations_message_participant_communication**](ConversationsApi.html#patch_conversations_message_participant_communication) | Update conversation participant's communication by disconnecting it.
|
|
101
|
+
[**patch_conversations_messaging_integrations_facebook_integration_id**](ConversationsApi.html#patch_conversations_messaging_integrations_facebook_integration_id) | Update Facebook messaging integration
|
|
101
102
|
[**patch_conversations_messaging_integrations_whatsapp_integration_id**](ConversationsApi.html#patch_conversations_messaging_integrations_whatsapp_integration_id) | Activate a WhatsApp messaging integration.
|
|
102
103
|
[**post_analytics_conversation_details_properties**](ConversationsApi.html#post_analytics_conversation_details_properties) | Index conversation properties
|
|
103
104
|
[**post_analytics_conversations_aggregates_query**](ConversationsApi.html#post_analytics_conversations_aggregates_query) | Query for conversation aggregates
|
|
104
105
|
[**post_analytics_conversations_details_jobs**](ConversationsApi.html#post_analytics_conversations_details_jobs) | Query for conversation details asynchronously
|
|
105
106
|
[**post_analytics_conversations_details_query**](ConversationsApi.html#post_analytics_conversations_details_query) | Query for conversation details
|
|
106
|
-
[**post_conversation_disconnect**](ConversationsApi.html#post_conversation_disconnect) | Performs a full conversation teardown. Issues disconnect requests for any connected media. Applies a system wrap-up code to any participants that are pending wrap-up. This is not intended to be the normal way of ending interactions but is available in the event of problems with the application to allow a
|
|
107
|
+
[**post_conversation_disconnect**](ConversationsApi.html#post_conversation_disconnect) | Performs a full conversation teardown. Issues disconnect requests for any connected media. Applies a system wrap-up code to any participants that are pending wrap-up. This is not intended to be the normal way of ending interactions but is available in the event of problems with the application to allow a resynchronization of state across all components. It is recommended that users submit a support case if they are relying on this endpoint systematically as there is likely something that needs investigation.
|
|
107
108
|
[**post_conversation_participant_callbacks**](ConversationsApi.html#post_conversation_participant_callbacks) | Create a new callback for the specified participant on the conversation.
|
|
108
109
|
[**post_conversation_participant_digits**](ConversationsApi.html#post_conversation_participant_digits) | Sends DTMF to the participant
|
|
109
110
|
[**post_conversation_participant_replace**](ConversationsApi.html#post_conversation_participant_replace) | Replace this participant with the specified user and/or address
|
|
@@ -6183,6 +6184,74 @@ Name | Type | Description | Notes
|
|
|
6183
6184
|
|
|
6184
6185
|
|
|
6185
6186
|
|
|
6187
|
+
<a name="patch_conversations_messaging_integrations_facebook_integration_id"></a>
|
|
6188
|
+
|
|
6189
|
+
## [**FacebookIntegration**](FacebookIntegration.html) patch_conversations_messaging_integrations_facebook_integration_id(integration_id, body)
|
|
6190
|
+
|
|
6191
|
+
|
|
6192
|
+
|
|
6193
|
+
Update Facebook messaging integration
|
|
6194
|
+
|
|
6195
|
+
|
|
6196
|
+
|
|
6197
|
+
Wraps PATCH /api/v2/conversations/messaging/integrations/facebook/{integrationId}
|
|
6198
|
+
|
|
6199
|
+
Requires ALL permissions:
|
|
6200
|
+
|
|
6201
|
+
* messaging:integration:edit
|
|
6202
|
+
|
|
6203
|
+
|
|
6204
|
+
### Example
|
|
6205
|
+
```{"language":"ruby"}
|
|
6206
|
+
# load the gem
|
|
6207
|
+
require 'purecloudplatformclientv2'
|
|
6208
|
+
# setup authorization
|
|
6209
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
6210
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
6211
|
+
environment = "mypurecloud.com"
|
|
6212
|
+
|
|
6213
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
6214
|
+
|
|
6215
|
+
PureCloud.configure do |config|
|
|
6216
|
+
config.access_token = @authToken
|
|
6217
|
+
end
|
|
6218
|
+
|
|
6219
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
6220
|
+
|
|
6221
|
+
integration_id = "integration_id_example" # String | Integration ID
|
|
6222
|
+
|
|
6223
|
+
body = PureCloud::FacebookIntegrationUpdateRequest.new # FacebookIntegrationUpdateRequest | FacebookIntegrationUpdateRequest
|
|
6224
|
+
|
|
6225
|
+
|
|
6226
|
+
begin
|
|
6227
|
+
#Update Facebook messaging integration
|
|
6228
|
+
result = api_instance.patch_conversations_messaging_integrations_facebook_integration_id(integration_id, body)
|
|
6229
|
+
p result
|
|
6230
|
+
rescue PureCloud::ApiError => e
|
|
6231
|
+
puts "Exception when calling ConversationsApi->patch_conversations_messaging_integrations_facebook_integration_id: #{e}"
|
|
6232
|
+
end
|
|
6233
|
+
```
|
|
6234
|
+
|
|
6235
|
+
### Parameters
|
|
6236
|
+
|
|
6237
|
+
Name | Type | Description | Notes
|
|
6238
|
+
------------- | ------------- | ------------- | -------------
|
|
6239
|
+
**integration_id** | **String**| Integration ID | |
|
|
6240
|
+
**body** | [**FacebookIntegrationUpdateRequest**](FacebookIntegrationUpdateRequest.html)| FacebookIntegrationUpdateRequest | |
|
|
6241
|
+
{: class="table table-striped"}
|
|
6242
|
+
|
|
6243
|
+
|
|
6244
|
+
### Return type
|
|
6245
|
+
|
|
6246
|
+
[**FacebookIntegration**](FacebookIntegration.html)
|
|
6247
|
+
|
|
6248
|
+
### HTTP request headers
|
|
6249
|
+
|
|
6250
|
+
- **Content-Type**: application/json
|
|
6251
|
+
- **Accept**: application/json
|
|
6252
|
+
|
|
6253
|
+
|
|
6254
|
+
|
|
6186
6255
|
<a name="patch_conversations_messaging_integrations_whatsapp_integration_id"></a>
|
|
6187
6256
|
|
|
6188
6257
|
## [**WhatsAppIntegration**](WhatsAppIntegration.html) patch_conversations_messaging_integrations_whatsapp_integration_id(integration_id, body)
|
|
@@ -6520,7 +6589,7 @@ Name | Type | Description | Notes
|
|
|
6520
6589
|
|
|
6521
6590
|
|
|
6522
6591
|
|
|
6523
|
-
Performs a full conversation teardown. Issues disconnect requests for any connected media. Applies a system wrap-up code to any participants that are pending wrap-up. This is not intended to be the normal way of ending interactions but is available in the event of problems with the application to allow a
|
|
6592
|
+
Performs a full conversation teardown. Issues disconnect requests for any connected media. Applies a system wrap-up code to any participants that are pending wrap-up. This is not intended to be the normal way of ending interactions but is available in the event of problems with the application to allow a resynchronization of state across all components. It is recommended that users submit a support case if they are relying on this endpoint systematically as there is likely something that needs investigation.
|
|
6524
6593
|
|
|
6525
6594
|
|
|
6526
6595
|
|
|
@@ -6552,7 +6621,7 @@ conversation_id = "conversation_id_example" # String | conversation ID
|
|
|
6552
6621
|
|
|
6553
6622
|
|
|
6554
6623
|
begin
|
|
6555
|
-
#Performs a full conversation teardown. Issues disconnect requests for any connected media. Applies a system wrap-up code to any participants that are pending wrap-up. This is not intended to be the normal way of ending interactions but is available in the event of problems with the application to allow a
|
|
6624
|
+
#Performs a full conversation teardown. Issues disconnect requests for any connected media. Applies a system wrap-up code to any participants that are pending wrap-up. This is not intended to be the normal way of ending interactions but is available in the event of problems with the application to allow a resynchronization of state across all components. It is recommended that users submit a support case if they are relying on this endpoint systematically as there is likely something that needs investigation.
|
|
6556
6625
|
result = api_instance.post_conversation_disconnect(conversation_id)
|
|
6557
6626
|
p result
|
|
6558
6627
|
rescue PureCloud::ApiError => e
|
|
@@ -8749,7 +8818,7 @@ Name | Type | Description | Notes
|
|
|
8749
8818
|
|
|
8750
8819
|
Create a WhatsApp Integration
|
|
8751
8820
|
|
|
8752
|
-
|
|
8821
|
+
You must be approved by WhatsApp to use this feature. Your approved e164-formatted phone number and valid WhatsApp certificate for your number are required. Your WhatsApp certificate must have valid base64 encoding. Please paste carefully and do not add any leading or trailing spaces. Do not alter any characters. An integration must be activated within 7 days of certificate generation. If you cannot complete the addition and activation of the number within 7 days, please obtain a new certificate before creating the integration. Integrations created with an invalid number or certificate may immediately incur additional integration fees. Please carefully enter your number and certificate as described.
|
|
8753
8822
|
|
|
8754
8823
|
Wraps POST /api/v2/conversations/messaging/integrations/whatsapp
|
|
8755
8824
|
|