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
|
@@ -7,14 +7,14 @@ title: ScimConfigResourceType
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **id** | **String** | The ID of the SCIM resource. Set by the service provider. \"caseExact\" is set to \"true\". \"
|
|
10
|
+
| **id** | **String** | The ID of the SCIM resource. Set by the service provider. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readOnly\". \"returned\" is set to \"always\". | [optional] |
|
|
11
11
|
| **schemas** | **Array<String>** | The list of supported schemas. | [optional] |
|
|
12
12
|
| **name** | **String** | The name of the resource type. | [optional] |
|
|
13
13
|
| **description** | **String** | The description of the resource type. | [optional] |
|
|
14
14
|
| **schema** | **String** | The URI of the primary or base schema for the resource type. | [optional] |
|
|
15
15
|
| **schema_extensions** | [**Array<ScimConfigResourceTypeSchemaExtension>**](ScimConfigResourceTypeSchemaExtension.html) | The list of schema extensions for the resource type. | [optional] |
|
|
16
16
|
| **endpoint** | **String** | The HTTP-addressable endpoint of the resource type. Appears after the base URL. | [optional] |
|
|
17
|
-
| **meta** | [**ScimMetadata**](ScimMetadata.html) | The metadata of the SCIM resource. | [optional] |
|
|
17
|
+
| **meta** | [**ScimMetadata**](ScimMetadata.html) | The metadata of the SCIM resource. Only location and resourceType are set for ResourceType resources. | [optional] |
|
|
18
18
|
{: class="table table-striped"}
|
|
19
19
|
|
|
20
20
|
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ScimGenesysUserExternalId
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::ScimGenesysUserExternalId
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **authority** | **String** | Authority, or scope, of the external id. Allows multiple external ids to be defined and should represent the source of the external identifier | [optional] |
|
|
11
|
+
| **value** | **String** | Identifier of the user in an external system. | [optional] |
|
|
12
|
+
{: class="table table-striped"}
|
|
13
|
+
|
|
14
|
+
|
data/docs/ScimMetadata.md
CHANGED
|
@@ -8,9 +8,9 @@ title: ScimMetadata
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
10
|
| **resource_type** | **String** | The type of SCIM resource. | [optional] |
|
|
11
|
-
| **last_modified** | **DateTime** | The last time that the resource was modified. Date time is represented as an ISO-8601 string, for example, yyyy-MM-ddTHH:mm:ss.SSSZ. | [optional] |
|
|
11
|
+
| **last_modified** | **DateTime** | The last time that the resource was modified. Date time is represented as an ISO-8601 string, for example, yyyy-MM-ddTHH:mm:ss.SSSZ. Not present on Schema and ResourceType resource. | [optional] |
|
|
12
12
|
| **location** | **String** | The URI of the resource. | [optional] |
|
|
13
|
-
| **version** | **String** | The version of the resource. Matches the ETag HTTP response header. | [optional] |
|
|
13
|
+
| **version** | **String** | The version of the resource. Matches the ETag HTTP response header. Not present on Schema and ResourceType resources. | [optional] |
|
|
14
14
|
{: class="table table-striped"}
|
|
15
15
|
|
|
16
16
|
|
data/docs/ScimUserExtensions.md
CHANGED
|
@@ -7,8 +7,9 @@ title: ScimUserExtensions
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **routing_skills** | [**Array<ScimUserRoutingSkill>**](ScimUserRoutingSkill.html) |
|
|
11
|
-
| **routing_languages** | [**Array<ScimUserRoutingLanguage>**](ScimUserRoutingLanguage.html) |
|
|
10
|
+
| **routing_skills** | [**Array<ScimUserRoutingSkill>**](ScimUserRoutingSkill.html) | The list of routing skills assigned to a user. Maximum 50 skills. | [optional] |
|
|
11
|
+
| **routing_languages** | [**Array<ScimUserRoutingLanguage>**](ScimUserRoutingLanguage.html) | The list of routing languages assigned to a user. Maximum 50 languages. | [optional] |
|
|
12
|
+
| **external_ids** | [**Array<ScimGenesysUserExternalId>**](ScimGenesysUserExternalId.html) | External Identifiers assigned to user. SCIM External ID will be visible here with authority prefix 'x-pc:scimv2:v1' but will be immutable. | [optional] |
|
|
12
13
|
{: class="table table-striped"}
|
|
13
14
|
|
|
14
15
|
|
data/docs/ScimUserRole.md
CHANGED
|
@@ -7,7 +7,7 @@ title: ScimUserRole
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **value** | **String** |
|
|
10
|
+
| **value** | **String** | The role of the Genesys Cloud user. | [optional] |
|
|
11
11
|
{: class="table table-striped"}
|
|
12
12
|
|
|
13
13
|
|
|
@@ -7,8 +7,8 @@ title: ScimUserRoutingLanguage
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **name** | **String** |
|
|
11
|
-
| **proficiency** | **Float** |
|
|
10
|
+
| **name** | **String** | The case-sensitive name of a routing language configured in Genesys Cloud. | |
|
|
11
|
+
| **proficiency** | **Float** | A rating from 0.0 to 5.0 that indicates how fluent an agent is in a particular language. ACD interactions are routed to agents with higher proficiency ratings. | [optional] |
|
|
12
12
|
{: class="table table-striped"}
|
|
13
13
|
|
|
14
14
|
|
|
@@ -7,8 +7,8 @@ title: ScimUserRoutingSkill
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **name** | **String** |
|
|
11
|
-
| **proficiency** | **Float** |
|
|
10
|
+
| **name** | **String** | The case-sensitive name of a routing skill configured in Genesys Cloud. | |
|
|
11
|
+
| **proficiency** | **Float** | A rating from 0.0 to 5.0 that indicates how adept an agent is at a particular skill. When \"Best available skills\" is enabled for a queue in Genesys Cloud, ACD interactions in that queue are routed to agents with higher proficiency ratings. | [optional] |
|
|
12
12
|
{: class="table table-striped"}
|
|
13
13
|
|
|
14
14
|
|
data/docs/ScimV2CreateUser.md
CHANGED
|
@@ -9,9 +9,9 @@ title: ScimV2CreateUser
|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
10
|
| **schemas** | **Array<String>** | The list of supported schemas. | [optional] |
|
|
11
11
|
| **active** | **BOOLEAN** | Indicates whether the user's administrative status is active. | [optional] |
|
|
12
|
-
| **user_name** | **String** | The user's
|
|
12
|
+
| **user_name** | **String** | The user's Genesys Cloud email address. Must be unique. | |
|
|
13
13
|
| **display_name** | **String** | The display name of the user. | |
|
|
14
|
-
| **password** | **String** | The new password for the
|
|
14
|
+
| **password** | **String** | The new password for the Genesys Cloud user. Does not return an existing password. | [optional] |
|
|
15
15
|
| **title** | **String** | The user's title. | [optional] |
|
|
16
16
|
| **phone_numbers** | [**Array<ScimPhoneNumber>**](ScimPhoneNumber.html) | The list of the user's phone numbers. | [optional] |
|
|
17
17
|
| **emails** | [**Array<ScimEmail>**](ScimEmail.html) | The list of the user's email addresses. | [optional] |
|
|
@@ -19,7 +19,7 @@ title: ScimV2CreateUser
|
|
|
19
19
|
| **groups** | [**Array<ScimV2GroupReference>**](ScimV2GroupReference.html) | The list of groups that the user is a member of. | [optional] |
|
|
20
20
|
| **roles** | [**Array<ScimUserRole>**](ScimUserRole.html) | The list of roles assigned to the user. | [optional] |
|
|
21
21
|
| **urnietfparamsscimschemasextensionenterprise2_0_user** | [**ScimV2EnterpriseUser**](ScimV2EnterpriseUser.html) | The URI of the schema for the enterprise user. | [optional] |
|
|
22
|
-
| **urnietfparamsscimschemasextensiongenesyspurecloud2_0_user** | [**ScimUserExtensions**](ScimUserExtensions.html) |
|
|
22
|
+
| **urnietfparamsscimschemasextensiongenesyspurecloud2_0_user** | [**ScimUserExtensions**](ScimUserExtensions.html) | The URI of the schema for the Genesys Cloud user. | [optional] |
|
|
23
23
|
{: class="table table-striped"}
|
|
24
24
|
|
|
25
25
|
|
data/docs/ScimV2Group.md
CHANGED
|
@@ -7,7 +7,7 @@ title: ScimV2Group
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **id** | **String** | The ID of the SCIM resource. Set by the service provider. \"caseExact\" is set to \"true\". \"
|
|
10
|
+
| **id** | **String** | The ID of the SCIM resource. Set by the service provider. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readOnly\". \"returned\" is set to \"always\". | [optional] |
|
|
11
11
|
| **schemas** | **Array<String>** | The list of supported schemas. | [optional] |
|
|
12
12
|
| **display_name** | **String** | The display name of the group. | |
|
|
13
13
|
| **external_id** | **String** | The external ID of the group. Set by the provisioning client. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readWrite\". | [optional] |
|
|
@@ -8,17 +8,17 @@ title: ScimV2SchemaAttribute
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
10
|
| **name** | **String** | The attribute's name | [optional] |
|
|
11
|
-
| **type** | **String** | The
|
|
12
|
-
| **sub_attributes** | [**Array<ScimV2SchemaAttribute>**](ScimV2SchemaAttribute.html) |
|
|
13
|
-
| **multi_valued** | **BOOLEAN** |
|
|
14
|
-
| **description** | **String** | The
|
|
15
|
-
| **required** | **BOOLEAN** |
|
|
16
|
-
| **canonical_values** | **Array<String>** |
|
|
17
|
-
| **case_exact** | **BOOLEAN** |
|
|
18
|
-
| **mutability** | **String** |
|
|
19
|
-
| **returned** | **String** |
|
|
20
|
-
| **uniqueness** | **String** |
|
|
21
|
-
| **reference_types** | **Array<String>** |
|
|
11
|
+
| **type** | **String** | The data type of the attribute. | [optional] |
|
|
12
|
+
| **sub_attributes** | [**Array<ScimV2SchemaAttribute>**](ScimV2SchemaAttribute.html) | The list of subattributes for an attribute of the type \"complex\". Uses the same schema as \"attributes\". | [optional] |
|
|
13
|
+
| **multi_valued** | **BOOLEAN** | Indicates whether an attribute contains multiple values. | [optional] |
|
|
14
|
+
| **description** | **String** | The description of the attribute. | [optional] |
|
|
15
|
+
| **required** | **BOOLEAN** | Indicates whether an attribute is required. | [optional] |
|
|
16
|
+
| **canonical_values** | **Array<String>** | The list of standard values that service providers may use. Service providers may ignore unsupported values. | [optional] |
|
|
17
|
+
| **case_exact** | **BOOLEAN** | Indicates whether a string attribute is case-sensitive. If set to \"true\", the server preserves case sensitivity. If set to \"false\", the server may change the case. The server also uses case sensitivity when evaluating filters. See section 3.4.2.2 \"Filtering\" in RFC 7644 for details. | [optional] |
|
|
18
|
+
| **mutability** | **String** | The circumstances under which an attribute can be defined or redefined. The default is \"readWrite\". | [optional] |
|
|
19
|
+
| **returned** | **String** | The circumstances under which an attribute and its values are returned in response to a GET, PUT, POST, or PATCH request. | [optional] |
|
|
20
|
+
| **uniqueness** | **String** | The method by which the service provider enforces the uniqueness of an attribute value. A server can reject a value by returning the HTTP response code 400 (Bad Request). A client can enforce uniqueness to a greater degree than the server provider enforces. For example, a client could make a value unique even though the server has \"uniqueness\" set to \"none\". | [optional] |
|
|
21
|
+
| **reference_types** | **Array<String>** | The list of SCIM resource types that may be referenced. Only applies when \"type\" is set to \"reference\". | [optional] |
|
|
22
22
|
{: class="table table-striped"}
|
|
23
23
|
|
|
24
24
|
|
|
@@ -7,11 +7,11 @@ title: ScimV2SchemaDefinition
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **id** | **String** | The ID of the SCIM resource. Set by the service provider. \"caseExact\" is set to \"true\". \"
|
|
11
|
-
| **name** | **String** |
|
|
12
|
-
| **description** | **String** |
|
|
13
|
-
| **attributes** | [**Array<ScimV2SchemaAttribute>**](ScimV2SchemaAttribute.html) |
|
|
14
|
-
| **meta** | [**ScimMetadata**](ScimMetadata.html) | The metadata of the SCIM resource. | [optional] |
|
|
10
|
+
| **id** | **String** | The ID of the SCIM resource. Set by the service provider. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readOnly\". \"returned\" is set to \"always\". | [optional] |
|
|
11
|
+
| **name** | **String** | The name of the schema. | [optional] |
|
|
12
|
+
| **description** | **String** | The description of the schema. | [optional] |
|
|
13
|
+
| **attributes** | [**Array<ScimV2SchemaAttribute>**](ScimV2SchemaAttribute.html) | The list of service provider attributes. | [optional] |
|
|
14
|
+
| **meta** | [**ScimMetadata**](ScimMetadata.html) | The metadata of the SCIM resource. Only location and resourceType are set for Schema resources. | [optional] |
|
|
15
15
|
{: class="table table-striped"}
|
|
16
16
|
|
|
17
17
|
|
|
@@ -10,7 +10,7 @@ title: ScimV2SchemaListResponse
|
|
|
10
10
|
| **total_results** | **Integer** | The total number of results. | [optional] |
|
|
11
11
|
| **start_index** | **Integer** | The 1-based index of the first result returned by this request. Add this to \"itemsPerPage\" when requesting the next page of results. | [optional] |
|
|
12
12
|
| **items_per_page** | **Integer** | The number of resources returned per page. | [optional] |
|
|
13
|
-
| **resources** | [**Array<ScimV2SchemaDefinition>**](ScimV2SchemaDefinition.html) |
|
|
13
|
+
| **resources** | [**Array<ScimV2SchemaDefinition>**](ScimV2SchemaDefinition.html) | The list of requested resources. | [optional] |
|
|
14
14
|
| **schemas** | **Array<String>** | The list of supported schemas. | [optional] |
|
|
15
15
|
{: class="table table-striped"}
|
|
16
16
|
|
data/docs/ScimV2User.md
CHANGED
|
@@ -7,12 +7,12 @@ title: ScimV2User
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **id** | **String** | The ID of the SCIM resource. Set by the service provider. \"caseExact\" is set to \"true\". \"
|
|
10
|
+
| **id** | **String** | The ID of the SCIM resource. Set by the service provider. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readOnly\". \"returned\" is set to \"always\". | [optional] |
|
|
11
11
|
| **schemas** | **Array<String>** | The list of supported schemas. | [optional] |
|
|
12
12
|
| **active** | **BOOLEAN** | Indicates whether the user's administrative status is active. | [optional] |
|
|
13
|
-
| **user_name** | **String** | The user's
|
|
13
|
+
| **user_name** | **String** | The user's Genesys Cloud email address. Must be unique. | [optional] |
|
|
14
14
|
| **display_name** | **String** | The display name of the user. | [optional] |
|
|
15
|
-
| **password** | **String** | The new password for the
|
|
15
|
+
| **password** | **String** | The new password for the Genesys Cloud user. Does not return an existing password. | [optional] |
|
|
16
16
|
| **title** | **String** | The user's title. | [optional] |
|
|
17
17
|
| **phone_numbers** | [**Array<ScimPhoneNumber>**](ScimPhoneNumber.html) | The list of the user's phone numbers. | [optional] |
|
|
18
18
|
| **emails** | [**Array<ScimEmail>**](ScimEmail.html) | The list of the user's email addresses. | [optional] |
|
|
@@ -20,7 +20,7 @@ title: ScimV2User
|
|
|
20
20
|
| **groups** | [**Array<ScimV2GroupReference>**](ScimV2GroupReference.html) | The list of groups that the user is a member of. | [optional] |
|
|
21
21
|
| **roles** | [**Array<ScimUserRole>**](ScimUserRole.html) | The list of roles assigned to the user. | [optional] |
|
|
22
22
|
| **urnietfparamsscimschemasextensionenterprise2_0_user** | [**ScimV2EnterpriseUser**](ScimV2EnterpriseUser.html) | The URI of the schema for the enterprise user. | [optional] |
|
|
23
|
-
| **urnietfparamsscimschemasextensiongenesyspurecloud2_0_user** | [**ScimUserExtensions**](ScimUserExtensions.html) |
|
|
23
|
+
| **urnietfparamsscimschemasextensiongenesyspurecloud2_0_user** | [**ScimUserExtensions**](ScimUserExtensions.html) | The URI of the schema for the Genesys Cloud user. | [optional] |
|
|
24
24
|
| **meta** | [**ScimMetadata**](ScimMetadata.html) | The metadata of the SCIM resource. | [optional] |
|
|
25
25
|
{: class="table table-striped"}
|
|
26
26
|
|
data/docs/Screenshare.md
CHANGED
|
@@ -20,6 +20,7 @@ title: Screenshare
|
|
|
20
20
|
| **peer_id** | **String** | The id of the peer communication corresponding to a matching leg for this communication. | [optional] |
|
|
21
21
|
| **segments** | [**Array<Segment>**](Segment.html) | The time line of the participant's call, divided into activity segments. | [optional] |
|
|
22
22
|
| **wrapup** | [**Wrapup**](Wrapup.html) | Call wrap up or disposition data. | [optional] |
|
|
23
|
+
| **after_call_work** | [**AfterCallWork**](AfterCallWork.html) | After-call work for the communication. | [optional] |
|
|
23
24
|
{: class="table table-striped"}
|
|
24
25
|
|
|
25
26
|
|
data/docs/SearchApi.md
CHANGED
|
@@ -447,7 +447,8 @@ api_instance = PureCloud::SearchApi.new
|
|
|
447
447
|
q64 = "q64_example" # String | q64
|
|
448
448
|
|
|
449
449
|
opts = {
|
|
450
|
-
expand: ["expand_example"] # Array<String> | expand
|
|
450
|
+
expand: ["expand_example"], # Array<String> | expand
|
|
451
|
+
integration_presence_source: "integration_presence_source_example" # String | integrationPresenceSource
|
|
451
452
|
}
|
|
452
453
|
|
|
453
454
|
begin
|
|
@@ -465,6 +466,7 @@ Name | Type | Description | Notes
|
|
|
465
466
|
------------- | ------------- | ------------- | -------------
|
|
466
467
|
**q64** | **String**| q64 | |
|
|
467
468
|
**expand** | [**Array<String>**](String.html)| expand | [optional] |
|
|
469
|
+
**integration_presence_source** | **String**| integrationPresenceSource | [optional] <br />**Values**: MicrosoftTeams, ZoomPhone |
|
|
468
470
|
{: class="table table-striped"}
|
|
469
471
|
|
|
470
472
|
|
|
@@ -1000,8 +1002,9 @@ Search users
|
|
|
1000
1002
|
|
|
1001
1003
|
Wraps POST /api/v2/users/search
|
|
1002
1004
|
|
|
1003
|
-
Requires
|
|
1005
|
+
Requires ANY permissions:
|
|
1004
1006
|
|
|
1007
|
+
* directory:user:view
|
|
1005
1008
|
|
|
1006
1009
|
|
|
1007
1010
|
### Example
|
data/docs/SmsConfig.md
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: SmsConfig
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::SmsConfig
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **message_column** | **String** | The Contact List column specifying the message to send to the contact. | |
|
|
11
|
+
| **phone_column** | **String** | The Contact List column specifying the phone number to send a message to. | |
|
|
12
|
+
| **sender_sms_phone_number** | [**SmsPhoneNumberRef**](SmsPhoneNumberRef.html) | A reference to the SMS Phone Number that will be used as the sender of a message. | |
|
|
13
|
+
{: class="table table-striped"}
|
|
14
|
+
|
|
15
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: SmsPhoneNumberRef
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::SmsPhoneNumberRef
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **phone_number** | **String** | A phone number provisioned for SMS communications in E.164 format. E.g. +13175555555 or +34234234234 | |
|
|
11
|
+
| **self_uri** | **String** | | [optional] |
|
|
12
|
+
{: class="table table-striped"}
|
|
13
|
+
|
|
14
|
+
|
data/docs/SocialExpression.md
CHANGED
|
@@ -25,6 +25,7 @@ title: SocialExpression
|
|
|
25
25
|
| **script_id** | **String** | The UUID of the script to use. | [optional] |
|
|
26
26
|
| **peer_id** | **String** | The id of the peer communication corresponding to a matching leg for this communication. | [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,147 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: SpeechTextAnalyticsApi
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
## PureCloud::SpeechTextAnalyticsApi
|
|
6
|
+
|
|
7
|
+
All URIs are relative to *https://api.mypurecloud.com*
|
|
8
|
+
|
|
9
|
+
Method | Description
|
|
10
|
+
------------- | ------------- | -------------
|
|
11
|
+
[**get_speechandtextanalytics_conversation**](SpeechTextAnalyticsApi.html#get_speechandtextanalytics_conversation) | Get Speech and Text Analytics for a specific conversation
|
|
12
|
+
[**get_speechandtextanalytics_conversation_communication_transcripturl**](SpeechTextAnalyticsApi.html#get_speechandtextanalytics_conversation_communication_transcripturl) | Get the pre-signed S3 URL for the transcript of a specific communication of a conversation
|
|
13
|
+
{: class="table table-striped"}
|
|
14
|
+
|
|
15
|
+
<a name="get_speechandtextanalytics_conversation"></a>
|
|
16
|
+
|
|
17
|
+
## [**ConversationMetrics**](ConversationMetrics.html) get_speechandtextanalytics_conversation(conversation_id)
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
Get Speech and Text Analytics for a specific conversation
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
Wraps GET /api/v2/speechandtextanalytics/conversations/{conversationId}
|
|
26
|
+
|
|
27
|
+
Requires ANY permissions:
|
|
28
|
+
|
|
29
|
+
* recording:recording:view
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
### Example
|
|
33
|
+
```{"language":"ruby"}
|
|
34
|
+
# load the gem
|
|
35
|
+
require 'purecloudplatformclientv2'
|
|
36
|
+
# setup authorization
|
|
37
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
38
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
39
|
+
environment = "mypurecloud.com"
|
|
40
|
+
|
|
41
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
42
|
+
|
|
43
|
+
PureCloud.configure do |config|
|
|
44
|
+
config.access_token = @authToken
|
|
45
|
+
end
|
|
46
|
+
|
|
47
|
+
api_instance = PureCloud::SpeechTextAnalyticsApi.new
|
|
48
|
+
|
|
49
|
+
conversation_id = "conversation_id_example" # String | Conversation Id
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
begin
|
|
53
|
+
#Get Speech and Text Analytics for a specific conversation
|
|
54
|
+
result = api_instance.get_speechandtextanalytics_conversation(conversation_id)
|
|
55
|
+
p result
|
|
56
|
+
rescue PureCloud::ApiError => e
|
|
57
|
+
puts "Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_conversation: #{e}"
|
|
58
|
+
end
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
### Parameters
|
|
62
|
+
|
|
63
|
+
Name | Type | Description | Notes
|
|
64
|
+
------------- | ------------- | ------------- | -------------
|
|
65
|
+
**conversation_id** | **String**| Conversation Id | |
|
|
66
|
+
{: class="table table-striped"}
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
### Return type
|
|
70
|
+
|
|
71
|
+
[**ConversationMetrics**](ConversationMetrics.html)
|
|
72
|
+
|
|
73
|
+
### HTTP request headers
|
|
74
|
+
|
|
75
|
+
- **Content-Type**: application/json
|
|
76
|
+
- **Accept**: application/json
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
<a name="get_speechandtextanalytics_conversation_communication_transcripturl"></a>
|
|
81
|
+
|
|
82
|
+
## [**TranscriptUrl**](TranscriptUrl.html) get_speechandtextanalytics_conversation_communication_transcripturl(conversation_id, communication_id)
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
Get the pre-signed S3 URL for the transcript of a specific communication of a conversation
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
Wraps GET /api/v2/speechandtextanalytics/conversations/{conversationId}/communications/{communicationId}/transcripturl
|
|
91
|
+
|
|
92
|
+
Requires ANY permissions:
|
|
93
|
+
|
|
94
|
+
* recording:recording:view
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
### Example
|
|
98
|
+
```{"language":"ruby"}
|
|
99
|
+
# load the gem
|
|
100
|
+
require 'purecloudplatformclientv2'
|
|
101
|
+
# setup authorization
|
|
102
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
103
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
104
|
+
environment = "mypurecloud.com"
|
|
105
|
+
|
|
106
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
107
|
+
|
|
108
|
+
PureCloud.configure do |config|
|
|
109
|
+
config.access_token = @authToken
|
|
110
|
+
end
|
|
111
|
+
|
|
112
|
+
api_instance = PureCloud::SpeechTextAnalyticsApi.new
|
|
113
|
+
|
|
114
|
+
conversation_id = "conversation_id_example" # String | Conversation ID
|
|
115
|
+
|
|
116
|
+
communication_id = "communication_id_example" # String | Communication ID
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
begin
|
|
120
|
+
#Get the pre-signed S3 URL for the transcript of a specific communication of a conversation
|
|
121
|
+
result = api_instance.get_speechandtextanalytics_conversation_communication_transcripturl(conversation_id, communication_id)
|
|
122
|
+
p result
|
|
123
|
+
rescue PureCloud::ApiError => e
|
|
124
|
+
puts "Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_conversation_communication_transcripturl: #{e}"
|
|
125
|
+
end
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
### Parameters
|
|
129
|
+
|
|
130
|
+
Name | Type | Description | Notes
|
|
131
|
+
------------- | ------------- | ------------- | -------------
|
|
132
|
+
**conversation_id** | **String**| Conversation ID | |
|
|
133
|
+
**communication_id** | **String**| Communication ID | |
|
|
134
|
+
{: class="table table-striped"}
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
### Return type
|
|
138
|
+
|
|
139
|
+
[**TranscriptUrl**](TranscriptUrl.html)
|
|
140
|
+
|
|
141
|
+
### HTTP request headers
|
|
142
|
+
|
|
143
|
+
- **Content-Type**: application/json
|
|
144
|
+
- **Accept**: application/json
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: StatEventFlowOutcomeTopicDatum
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::StatEventFlowOutcomeTopicDatum
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **interval** | **String** | | [optional] |
|
|
11
|
+
| **metrics** | [**Array<StatEventFlowOutcomeTopicMetric>**](StatEventFlowOutcomeTopicMetric.html) | | [optional] |
|
|
12
|
+
{: class="table table-striped"}
|
|
13
|
+
|
|
14
|
+
|