purecloudplatformclientv2 91.0.0 → 96.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +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,11 +7,10 @@ title: ExternalOrganizationTrustorLink
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
10
|
| **external_organization_id** | **String** | The id of a PureCloud External Organization entity in the External Contacts system that will be used to represent the trustor org | [optional] |
|
|
12
11
|
| **trustor_org_id** | **String** | The id of a PureCloud organization that has granted trust to this PureCloud organization | [optional] |
|
|
13
12
|
| **date_created** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
14
|
-
| **
|
|
13
|
+
| **external_organization_uri** | **String** | The URI for the External Organization that is linked to the trustor org | [optional] |
|
|
15
14
|
{: class="table table-striped"}
|
|
16
15
|
|
|
17
16
|
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: FacebookIntegrationUpdateRequest
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::FacebookIntegrationUpdateRequest
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **page_access_token** | **String** | The long-lived Page Access Token of a facebook page. See https://developers.facebook.com/docs/facebook-login/access-tokens. Either pageAccessToken or userAccessToken should be provided. | [optional] |
|
|
11
|
+
| **user_access_token** | **String** | The short-lived User Access Token of the facebook user logged into the facebook app. See https://developers.facebook.com/docs/facebook-login/access-tokens. Either pageAccessToken or userAccessToken should be provided. | [optional] |
|
|
12
|
+
{: class="table table-striped"}
|
|
13
|
+
|
|
14
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: GoogleDialogflowCustomSettings
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::GoogleDialogflowCustomSettings
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **environment** | **String** | If set this environment will be used to initiate the dialogflow bot, otherwise the default configuration will be used. See https://cloud.google.com/dialogflow/docs/agents-versions | [optional] |
|
|
11
|
+
{: class="table table-striped"}
|
|
12
|
+
|
|
13
|
+
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: HistoricalAdherenceActuals
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::HistoricalAdherenceActuals
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **actual_activity_category** | **String** | Activity in which the user is actually engaged | [optional] |
|
|
11
|
+
| **start_offset_seconds** | **Integer** | Actual start offset in seconds relative to query start time | [optional] |
|
|
12
|
+
| **end_offset_seconds** | **Integer** | Actual end offset in seconds relative to query start time | [optional] |
|
|
13
|
+
{: class="table table-striped"}
|
|
14
|
+
|
|
15
|
+
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: HistoricalAdherenceDayMetrics
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::HistoricalAdherenceDayMetrics
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **day_start_offset_secs** | **Integer** | Start of day offset in seconds relative to query start time | [optional] |
|
|
11
|
+
| **adherence_schedule_secs** | **Integer** | Duration of schedule in seconds included for adherence percentage calculation | [optional] |
|
|
12
|
+
| **conformance_schedule_secs** | **Integer** | Total scheduled duration in seconds for OnQueue activities | [optional] |
|
|
13
|
+
| **conformance_actual_secs** | **Integer** | Total actually worked duration in seconds for OnQueue activities | [optional] |
|
|
14
|
+
| **exception_count** | **Integer** | Total number of adherence exceptions for this user | [optional] |
|
|
15
|
+
| **exception_duration_secs** | **Integer** | Total duration in seconds of adherence exceptions for this user | [optional] |
|
|
16
|
+
| **impact_seconds** | **Integer** | The impact duration in seconds of current adherence state for this user | [optional] |
|
|
17
|
+
| **schedule_length_secs** | **Integer** | Total duration in seconds for all scheduled activities | [optional] |
|
|
18
|
+
| **actual_length_secs** | **Integer** | Total duration in seconds for all actually worked activities | [optional] |
|
|
19
|
+
| **adherence_percentage** | **Float** | Total adherence percentage for this user, in the scale of 0 - 100 | [optional] |
|
|
20
|
+
| **conformance_percentage** | **Float** | Total conformance percentage for this user, in the scale of 0 - 100. Conformance percentage can be greater than 100 when the actual on queue time is greater than the scheduled on queue time for the same period. | [optional] |
|
|
21
|
+
{: class="table table-striped"}
|
|
22
|
+
|
|
23
|
+
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: HistoricalAdherenceExceptionInfo
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::HistoricalAdherenceExceptionInfo
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **start_offset_seconds** | **Integer** | Exception start offset in seconds relative to query start time | [optional] |
|
|
11
|
+
| **end_offset_seconds** | **Integer** | Exception end offset in seconds relative to query start time | [optional] |
|
|
12
|
+
| **scheduled_activity_code_id** | **String** | The ID of the scheduled activity for this user | [optional] |
|
|
13
|
+
| **scheduled_activity_category** | **String** | Activity for which the user is scheduled | [optional] |
|
|
14
|
+
| **actual_activity_category** | **String** | Activity for which the user is actually engaged | [optional] |
|
|
15
|
+
| **system_presence** | **String** | Actual underlying system presence value | [optional] |
|
|
16
|
+
| **routing_status** | [**RoutingStatus**](RoutingStatus.html) | Actual underlying routing status, used to determine whether a user is actually in adherence when OnQueue | [optional] |
|
|
17
|
+
| **impact** | **String** | The impact of the current adherence state for this user | [optional] |
|
|
18
|
+
| **secondary_presence_lookup_id** | **String** | The lookup ID used to retrieve secondary status from map of lookup ID to corresponding secondary presence ID | [optional] |
|
|
19
|
+
{: class="table table-striped"}
|
|
20
|
+
|
|
21
|
+
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: HistoricalAdherenceQueryResult
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::HistoricalAdherenceQueryResult
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **user_id** | **String** | The ID of the user for whom the adherence is queried | [optional] |
|
|
11
|
+
| **start_date** | **DateTime** | Beginning of the date range that was queried, in ISO-8601 format | [optional] |
|
|
12
|
+
| **end_date** | **DateTime** | End of the date range that was queried, in ISO-8601 format. If it was not set, end date will be set to the queried time | [optional] |
|
|
13
|
+
| **adherence_percentage** | **Float** | Adherence percentage for this user, in the scale of 0 - 100 | [optional] |
|
|
14
|
+
| **conformance_percentage** | **Float** | Conformance percentage for this user, in the scale of 0 - 100. Conformance percentage can be greater than 100 when the actual on queue time is greater than the scheduled on queue time for the same period. | [optional] |
|
|
15
|
+
| **impact** | **String** | The impact of the current adherence state for this user | [optional] |
|
|
16
|
+
| **exception_info** | [**Array<HistoricalAdherenceExceptionInfo>**](HistoricalAdherenceExceptionInfo.html) | List of adherence exceptions for this user | [optional] |
|
|
17
|
+
| **day_metrics** | [**Array<HistoricalAdherenceDayMetrics>**](HistoricalAdherenceDayMetrics.html) | Adherence and conformance metrics for days in query range | [optional] |
|
|
18
|
+
| **actuals** | [**Array<HistoricalAdherenceActuals>**](HistoricalAdherenceActuals.html) | List of actual activity with offset for this user | [optional] |
|
|
19
|
+
{: class="table table-striped"}
|
|
20
|
+
|
|
21
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: JourneyAggregateDataContainer
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::JourneyAggregateDataContainer
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **group** | **Hash<String, String>** | A mapping from dimension to value | [optional] |
|
|
11
|
+
| **data** | [**Array<StatisticalResponse>**](StatisticalResponse.html) | | [optional] |
|
|
12
|
+
{: class="table table-striped"}
|
|
13
|
+
|
|
14
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: JourneyAggregateQueryClause
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::JourneyAggregateQueryClause
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **type** | **String** | Boolean operation to apply to the provided predicates | |
|
|
11
|
+
| **predicates** | [**Array<JourneyAggregateQueryPredicate>**](JourneyAggregateQueryPredicate.html) | Like a three-word sentence: (attribute-name) (operator) (target-value). | |
|
|
12
|
+
{: class="table table-striped"}
|
|
13
|
+
|
|
14
|
+
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: JourneyAggregateQueryFilter
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::JourneyAggregateQueryFilter
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **type** | **String** | Boolean operation to apply to the provided predicates and clauses | |
|
|
11
|
+
| **clauses** | [**Array<JourneyAggregateQueryClause>**](JourneyAggregateQueryClause.html) | Boolean 'and/or' logic with up to two-levels of nesting | [optional] |
|
|
12
|
+
| **predicates** | [**Array<JourneyAggregateQueryPredicate>**](JourneyAggregateQueryPredicate.html) | Like a three-word sentence: (attribute-name) (operator) (target-value). | [optional] |
|
|
13
|
+
{: class="table table-striped"}
|
|
14
|
+
|
|
15
|
+
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: JourneyAggregateQueryPredicate
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::JourneyAggregateQueryPredicate
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **type** | **String** | Optional type, can usually be inferred | [optional] |
|
|
11
|
+
| **dimension** | **String** | Left hand side for dimension predicates | [optional] |
|
|
12
|
+
| **operator** | **String** | Optional operator, default is matches | [optional] |
|
|
13
|
+
| **value** | **String** | Right hand side for dimension predicates | [optional] |
|
|
14
|
+
| **range** | [**NumericRange**](NumericRange.html) | Right hand side for dimension predicates | [optional] |
|
|
15
|
+
{: class="table table-striped"}
|
|
16
|
+
|
|
17
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: JourneyAggregateQueryResponse
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::JourneyAggregateQueryResponse
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **results** | [**Array<JourneyAggregateDataContainer>**](JourneyAggregateDataContainer.html) | | [optional] |
|
|
11
|
+
{: class="table table-striped"}
|
|
12
|
+
|
|
13
|
+
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: JourneyAggregationQuery
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::JourneyAggregationQuery
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **interval** | **String** | Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | |
|
|
11
|
+
| **granularity** | **String** | Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H | [optional] |
|
|
12
|
+
| **time_zone** | **String** | Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London | [optional] |
|
|
13
|
+
| **group_by** | **Array<String>** | Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group. | [optional] |
|
|
14
|
+
| **filter** | [**JourneyAggregateQueryFilter**](JourneyAggregateQueryFilter.html) | Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters | [optional] |
|
|
15
|
+
| **metrics** | **Array<String>** | Behaves like a SQL SELECT clause. Enables retrieving only named metrics. If omitted, all metrics that are available will be returned (like SELECT *). | [optional] |
|
|
16
|
+
| **flatten_multivalued_dimensions** | **BOOLEAN** | Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c') | [optional] |
|
|
17
|
+
| **views** | [**Array<JourneyAggregationView>**](JourneyAggregationView.html) | Custom derived metric views | [optional] |
|
|
18
|
+
| **alternate_time_dimension** | **String** | Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event. | [optional] |
|
|
19
|
+
{: class="table table-striped"}
|
|
20
|
+
|
|
21
|
+
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: JourneyAggregationView
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::JourneyAggregationView
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **target** | **String** | Target metric name | |
|
|
11
|
+
| **name** | **String** | A unique name for this view. Must be distinct from other views and built-in metric names. | |
|
|
12
|
+
| **function** | **String** | Type of view you wish to create | |
|
|
13
|
+
| **range** | [**AggregationRange**](AggregationRange.html) | Range of numbers for slicing up data | [optional] |
|
|
14
|
+
{: class="table table-striped"}
|
|
15
|
+
|
|
16
|
+
|
data/docs/JourneyApi.md
ADDED
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: JourneyApi
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
## PureCloud::JourneyApi
|
|
6
|
+
|
|
7
|
+
All URIs are relative to *https://api.mypurecloud.com*
|
|
8
|
+
|
|
9
|
+
Method | Description
|
|
10
|
+
------------- | ------------- | -------------
|
|
11
|
+
[**post_analytics_journeys_aggregates_query**](JourneyApi.html#post_analytics_journeys_aggregates_query) | Query for journey aggregates
|
|
12
|
+
{: class="table table-striped"}
|
|
13
|
+
|
|
14
|
+
<a name="post_analytics_journeys_aggregates_query"></a>
|
|
15
|
+
|
|
16
|
+
## [**JourneyAggregateQueryResponse**](JourneyAggregateQueryResponse.html) post_analytics_journeys_aggregates_query(body)
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
Query for journey aggregates
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
Wraps POST /api/v2/analytics/journeys/aggregates/query
|
|
25
|
+
|
|
26
|
+
Requires ANY permissions:
|
|
27
|
+
|
|
28
|
+
* analytics:journeyAggregate:view
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
### Example
|
|
32
|
+
```{"language":"ruby"}
|
|
33
|
+
# load the gem
|
|
34
|
+
require 'purecloudplatformclientv2'
|
|
35
|
+
# setup authorization
|
|
36
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
37
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
38
|
+
environment = "mypurecloud.com"
|
|
39
|
+
|
|
40
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
41
|
+
|
|
42
|
+
PureCloud.configure do |config|
|
|
43
|
+
config.access_token = @authToken
|
|
44
|
+
end
|
|
45
|
+
|
|
46
|
+
api_instance = PureCloud::JourneyApi.new
|
|
47
|
+
|
|
48
|
+
body = PureCloud::JourneyAggregationQuery.new # JourneyAggregationQuery | query
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
begin
|
|
52
|
+
#Query for journey aggregates
|
|
53
|
+
result = api_instance.post_analytics_journeys_aggregates_query(body)
|
|
54
|
+
p result
|
|
55
|
+
rescue PureCloud::ApiError => e
|
|
56
|
+
puts "Exception when calling JourneyApi->post_analytics_journeys_aggregates_query: #{e}"
|
|
57
|
+
end
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
### Parameters
|
|
61
|
+
|
|
62
|
+
Name | Type | Description | Notes
|
|
63
|
+
------------- | ------------- | ------------- | -------------
|
|
64
|
+
**body** | [**JourneyAggregationQuery**](JourneyAggregationQuery.html)| query | |
|
|
65
|
+
{: class="table table-striped"}
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
### Return type
|
|
69
|
+
|
|
70
|
+
[**JourneyAggregateQueryResponse**](JourneyAggregateQueryResponse.html)
|
|
71
|
+
|
|
72
|
+
### HTTP request headers
|
|
73
|
+
|
|
74
|
+
- **Content-Type**: application/json
|
|
75
|
+
- **Accept**: application/json
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
|
data/docs/JsonNode.md
CHANGED
|
@@ -12,11 +12,8 @@ title: JsonNode
|
|
|
12
12
|
| **number** | **BOOLEAN** | | [optional] |
|
|
13
13
|
| **boolean** | **BOOLEAN** | | [optional] |
|
|
14
14
|
| **object** | **BOOLEAN** | | [optional] |
|
|
15
|
-
| **value_node** | **BOOLEAN** | | [optional] |
|
|
16
|
-
| **container_node** | **BOOLEAN** | | [optional] |
|
|
17
|
-
| **missing_node** | **BOOLEAN** | | [optional] |
|
|
18
|
-
| **pojo** | **BOOLEAN** | | [optional] |
|
|
19
15
|
| **floating_point_number** | **BOOLEAN** | | [optional] |
|
|
16
|
+
| **pojo** | **BOOLEAN** | | [optional] |
|
|
20
17
|
| **integral_number** | **BOOLEAN** | | [optional] |
|
|
21
18
|
| **short** | **BOOLEAN** | | [optional] |
|
|
22
19
|
| **int** | **BOOLEAN** | | [optional] |
|
|
@@ -26,6 +23,9 @@ title: JsonNode
|
|
|
26
23
|
| **big_integer** | **BOOLEAN** | | [optional] |
|
|
27
24
|
| **textual** | **BOOLEAN** | | [optional] |
|
|
28
25
|
| **binary** | **BOOLEAN** | | [optional] |
|
|
26
|
+
| **value_node** | **BOOLEAN** | | [optional] |
|
|
27
|
+
| **container_node** | **BOOLEAN** | | [optional] |
|
|
28
|
+
| **missing_node** | **BOOLEAN** | | [optional] |
|
|
29
29
|
| **array** | **BOOLEAN** | | [optional] |
|
|
30
30
|
| **null** | **BOOLEAN** | | [optional] |
|
|
31
31
|
{: class="table table-striped"}
|
|
@@ -8,9 +8,9 @@ title: KnowledgeSearchRequest
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
10
|
| **query** | **String** | Input query to search content in the knowledge base | |
|
|
11
|
-
| **page_size** | **Integer** | Page size of the returned results | |
|
|
12
|
-
| **page_number** | **Integer** | Page number of the returned results | |
|
|
13
|
-
| **document_type** | **String** | Document type to be used while searching | |
|
|
11
|
+
| **page_size** | **Integer** | Page size of the returned results | [optional] |
|
|
12
|
+
| **page_number** | **Integer** | Page number of the returned results | [optional] |
|
|
13
|
+
| **document_type** | **String** | Document type to be used while searching | [optional] |
|
|
14
14
|
| **language_code** | **String** | query search for specific languageCode | |
|
|
15
15
|
| **search_on_draft_documents** | **BOOLEAN** | If true the search query will be executed on draft documents, else it will be on active documents | [optional] |
|
|
16
16
|
{: class="table table-striped"}
|
|
@@ -10,6 +10,7 @@ Method | Description
|
|
|
10
10
|
------------- | ------------- | -------------
|
|
11
11
|
[**delete_languageunderstanding_domain**](LanguageUnderstandingApi.html#delete_languageunderstanding_domain) | Delete an NLU Domain.
|
|
12
12
|
[**delete_languageunderstanding_domain_feedback_feedback_id**](LanguageUnderstandingApi.html#delete_languageunderstanding_domain_feedback_feedback_id) | Delete the feedback on the NLU Domain Version.
|
|
13
|
+
[**delete_languageunderstanding_domain_version**](LanguageUnderstandingApi.html#delete_languageunderstanding_domain_version) | Delete an NLU Domain Version
|
|
13
14
|
[**get_languageunderstanding_domain**](LanguageUnderstandingApi.html#get_languageunderstanding_domain) | Find an NLU Domain.
|
|
14
15
|
[**get_languageunderstanding_domain_feedback**](LanguageUnderstandingApi.html#get_languageunderstanding_domain_feedback) | Get all feedback in the given NLU Domain Version.
|
|
15
16
|
[**get_languageunderstanding_domain_feedback_feedback_id**](LanguageUnderstandingApi.html#get_languageunderstanding_domain_feedback_feedback_id) | Find a Feedback
|
|
@@ -22,6 +23,7 @@ Method | Description
|
|
|
22
23
|
[**post_languageunderstanding_domain_version_detect**](LanguageUnderstandingApi.html#post_languageunderstanding_domain_version_detect) | Detect intent, entities, etc. in the submitted text using the specified NLU domain version.
|
|
23
24
|
[**post_languageunderstanding_domain_version_publish**](LanguageUnderstandingApi.html#post_languageunderstanding_domain_version_publish) | Publish the draft NLU Domain Version.
|
|
24
25
|
[**post_languageunderstanding_domain_version_train**](LanguageUnderstandingApi.html#post_languageunderstanding_domain_version_train) | Train the draft NLU Domain Version.
|
|
26
|
+
[**post_languageunderstanding_domain_versions**](LanguageUnderstandingApi.html#post_languageunderstanding_domain_versions) | Create an NLU Domain Version.
|
|
25
27
|
[**post_languageunderstanding_domains**](LanguageUnderstandingApi.html#post_languageunderstanding_domains) | Create an NLU Domain.
|
|
26
28
|
[**put_languageunderstanding_domain_version**](LanguageUnderstandingApi.html#put_languageunderstanding_domain_version) | Update an NLU Domain Version.
|
|
27
29
|
{: class="table table-striped"}
|
|
@@ -159,6 +161,74 @@ nil (empty response body)
|
|
|
159
161
|
|
|
160
162
|
|
|
161
163
|
|
|
164
|
+
<a name="delete_languageunderstanding_domain_version"></a>
|
|
165
|
+
|
|
166
|
+
## delete_languageunderstanding_domain_version(domain_id, domain_version_id)
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
Delete an NLU Domain Version
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
Wraps DELETE /api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}
|
|
175
|
+
|
|
176
|
+
Requires ANY permissions:
|
|
177
|
+
|
|
178
|
+
* languageUnderstanding:nluDomainVersion:delete
|
|
179
|
+
* dialog:botVersion:delete
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
### Example
|
|
183
|
+
```{"language":"ruby"}
|
|
184
|
+
# load the gem
|
|
185
|
+
require 'purecloudplatformclientv2'
|
|
186
|
+
# setup authorization
|
|
187
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
188
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
189
|
+
environment = "mypurecloud.com"
|
|
190
|
+
|
|
191
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
192
|
+
|
|
193
|
+
PureCloud.configure do |config|
|
|
194
|
+
config.access_token = @authToken
|
|
195
|
+
end
|
|
196
|
+
|
|
197
|
+
api_instance = PureCloud::LanguageUnderstandingApi.new
|
|
198
|
+
|
|
199
|
+
domain_id = "domain_id_example" # String | ID of the NLU domain.
|
|
200
|
+
|
|
201
|
+
domain_version_id = "domain_version_id_example" # String | ID of the NLU domain version.
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
begin
|
|
205
|
+
#Delete an NLU Domain Version
|
|
206
|
+
api_instance.delete_languageunderstanding_domain_version(domain_id, domain_version_id)
|
|
207
|
+
rescue PureCloud::ApiError => e
|
|
208
|
+
puts "Exception when calling LanguageUnderstandingApi->delete_languageunderstanding_domain_version: #{e}"
|
|
209
|
+
end
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
### Parameters
|
|
213
|
+
|
|
214
|
+
Name | Type | Description | Notes
|
|
215
|
+
------------- | ------------- | ------------- | -------------
|
|
216
|
+
**domain_id** | **String**| ID of the NLU domain. | |
|
|
217
|
+
**domain_version_id** | **String**| ID of the NLU domain version. | |
|
|
218
|
+
{: class="table table-striped"}
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
### Return type
|
|
222
|
+
|
|
223
|
+
nil (empty response body)
|
|
224
|
+
|
|
225
|
+
### HTTP request headers
|
|
226
|
+
|
|
227
|
+
- **Content-Type**: application/json
|
|
228
|
+
- **Accept**: application/json
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
|
|
162
232
|
<a name="get_languageunderstanding_domain"></a>
|
|
163
233
|
|
|
164
234
|
## [**NluDomain**](NluDomain.html) get_languageunderstanding_domain(domain_id)
|
|
@@ -288,7 +358,7 @@ Name | Type | Description | Notes
|
|
|
288
358
|
------------- | ------------- | ------------- | -------------
|
|
289
359
|
**domain_id** | **String**| ID of the NLU domain. | |
|
|
290
360
|
**intent_name** | **String**| The top intent name to retrieve feedback for. | [optional] |
|
|
291
|
-
**assessment** | **String**| The top assessment to retrieve feedback for. | [optional] <br />**Values**: Incorrect, Correct, Unknown |
|
|
361
|
+
**assessment** | **String**| The top assessment to retrieve feedback for. | [optional] <br />**Values**: Incorrect, Correct, Unknown, Disabled |
|
|
292
362
|
**date_start** | **Date**| Begin of time window as ISO-8601 date. | [optional] |
|
|
293
363
|
**date_end** | **Date**| End of time window as ISO-8601 date. | [optional] |
|
|
294
364
|
**include_deleted** | **BOOLEAN**| Whether to include soft-deleted items in the result. | [optional] |
|
|
@@ -669,7 +739,7 @@ Name | Type | Description | Notes
|
|
|
669
739
|
|
|
670
740
|
<a name="patch_languageunderstanding_domain"></a>
|
|
671
741
|
|
|
672
|
-
## [**NluDomain**](NluDomain.html) patch_languageunderstanding_domain(domain_id,
|
|
742
|
+
## [**NluDomain**](NluDomain.html) patch_languageunderstanding_domain(domain_id, body)
|
|
673
743
|
|
|
674
744
|
|
|
675
745
|
|
|
@@ -704,13 +774,12 @@ api_instance = PureCloud::LanguageUnderstandingApi.new
|
|
|
704
774
|
|
|
705
775
|
domain_id = "domain_id_example" # String | ID of the NLU domain.
|
|
706
776
|
|
|
707
|
-
|
|
708
|
-
|
|
709
|
-
}
|
|
777
|
+
body = PureCloud::NluDomain.new # NluDomain | The updated NLU Domain.
|
|
778
|
+
|
|
710
779
|
|
|
711
780
|
begin
|
|
712
781
|
#Update an NLU Domain.
|
|
713
|
-
result = api_instance.patch_languageunderstanding_domain(domain_id,
|
|
782
|
+
result = api_instance.patch_languageunderstanding_domain(domain_id, body)
|
|
714
783
|
p result
|
|
715
784
|
rescue PureCloud::ApiError => e
|
|
716
785
|
puts "Exception when calling LanguageUnderstandingApi->patch_languageunderstanding_domain: #{e}"
|
|
@@ -722,7 +791,7 @@ end
|
|
|
722
791
|
Name | Type | Description | Notes
|
|
723
792
|
------------- | ------------- | ------------- | -------------
|
|
724
793
|
**domain_id** | **String**| ID of the NLU domain. | |
|
|
725
|
-
**body** | [**NluDomain**](NluDomain.html)|
|
|
794
|
+
**body** | [**NluDomain**](NluDomain.html)| The updated NLU Domain. | |
|
|
726
795
|
{: class="table table-striped"}
|
|
727
796
|
|
|
728
797
|
|
|
@@ -739,7 +808,7 @@ Name | Type | Description | Notes
|
|
|
739
808
|
|
|
740
809
|
<a name="post_languageunderstanding_domain_feedback"></a>
|
|
741
810
|
|
|
742
|
-
## [**NluFeedbackResponse**](NluFeedbackResponse.html) post_languageunderstanding_domain_feedback(domain_id,
|
|
811
|
+
## [**NluFeedbackResponse**](NluFeedbackResponse.html) post_languageunderstanding_domain_feedback(domain_id, body)
|
|
743
812
|
|
|
744
813
|
|
|
745
814
|
|
|
@@ -774,13 +843,12 @@ api_instance = PureCloud::LanguageUnderstandingApi.new
|
|
|
774
843
|
|
|
775
844
|
domain_id = "domain_id_example" # String | ID of the NLU domain.
|
|
776
845
|
|
|
777
|
-
|
|
778
|
-
|
|
779
|
-
}
|
|
846
|
+
body = PureCloud::NluFeedbackRequest.new # NluFeedbackRequest | The Feedback to create.
|
|
847
|
+
|
|
780
848
|
|
|
781
849
|
begin
|
|
782
850
|
#Create feedback for the NLU Domain Version.
|
|
783
|
-
result = api_instance.post_languageunderstanding_domain_feedback(domain_id,
|
|
851
|
+
result = api_instance.post_languageunderstanding_domain_feedback(domain_id, body)
|
|
784
852
|
p result
|
|
785
853
|
rescue PureCloud::ApiError => e
|
|
786
854
|
puts "Exception when calling LanguageUnderstandingApi->post_languageunderstanding_domain_feedback: #{e}"
|
|
@@ -792,7 +860,7 @@ end
|
|
|
792
860
|
Name | Type | Description | Notes
|
|
793
861
|
------------- | ------------- | ------------- | -------------
|
|
794
862
|
**domain_id** | **String**| ID of the NLU domain. | |
|
|
795
|
-
**body** | [**NluFeedbackRequest**](NluFeedbackRequest.html)|
|
|
863
|
+
**body** | [**NluFeedbackRequest**](NluFeedbackRequest.html)| The Feedback to create. | |
|
|
796
864
|
{: class="table table-striped"}
|
|
797
865
|
|
|
798
866
|
|
|
@@ -809,7 +877,7 @@ Name | Type | Description | Notes
|
|
|
809
877
|
|
|
810
878
|
<a name="post_languageunderstanding_domain_version_detect"></a>
|
|
811
879
|
|
|
812
|
-
## [**NluDetectionResponse**](NluDetectionResponse.html) post_languageunderstanding_domain_version_detect(domain_id, domain_version_id,
|
|
880
|
+
## [**NluDetectionResponse**](NluDetectionResponse.html) post_languageunderstanding_domain_version_detect(domain_id, domain_version_id, body)
|
|
813
881
|
|
|
814
882
|
|
|
815
883
|
|
|
@@ -846,13 +914,12 @@ domain_id = "domain_id_example" # String | ID of the NLU domain.
|
|
|
846
914
|
|
|
847
915
|
domain_version_id = "domain_version_id_example" # String | ID of the NLU domain version.
|
|
848
916
|
|
|
849
|
-
|
|
850
|
-
|
|
851
|
-
}
|
|
917
|
+
body = PureCloud::NluDetectionRequest.new # NluDetectionRequest | The input data to perform detection on.
|
|
918
|
+
|
|
852
919
|
|
|
853
920
|
begin
|
|
854
921
|
#Detect intent, entities, etc. in the submitted text using the specified NLU domain version.
|
|
855
|
-
result = api_instance.post_languageunderstanding_domain_version_detect(domain_id, domain_version_id,
|
|
922
|
+
result = api_instance.post_languageunderstanding_domain_version_detect(domain_id, domain_version_id, body)
|
|
856
923
|
p result
|
|
857
924
|
rescue PureCloud::ApiError => e
|
|
858
925
|
puts "Exception when calling LanguageUnderstandingApi->post_languageunderstanding_domain_version_detect: #{e}"
|
|
@@ -865,7 +932,7 @@ Name | Type | Description | Notes
|
|
|
865
932
|
------------- | ------------- | ------------- | -------------
|
|
866
933
|
**domain_id** | **String**| ID of the NLU domain. | |
|
|
867
934
|
**domain_version_id** | **String**| ID of the NLU domain version. | |
|
|
868
|
-
**body** | [**NluDetectionRequest**](NluDetectionRequest.html)|
|
|
935
|
+
**body** | [**NluDetectionRequest**](NluDetectionRequest.html)| The input data to perform detection on. | |
|
|
869
936
|
{: class="table table-striped"}
|
|
870
937
|
|
|
871
938
|
|
|
@@ -1018,9 +1085,78 @@ Name | Type | Description | Notes
|
|
|
1018
1085
|
|
|
1019
1086
|
|
|
1020
1087
|
|
|
1088
|
+
<a name="post_languageunderstanding_domain_versions"></a>
|
|
1089
|
+
|
|
1090
|
+
## [**NluDomainVersion**](NluDomainVersion.html) post_languageunderstanding_domain_versions(domain_id, body)
|
|
1091
|
+
|
|
1092
|
+
|
|
1093
|
+
|
|
1094
|
+
Create an NLU Domain Version.
|
|
1095
|
+
|
|
1096
|
+
|
|
1097
|
+
|
|
1098
|
+
Wraps POST /api/v2/languageunderstanding/domains/{domainId}/versions
|
|
1099
|
+
|
|
1100
|
+
Requires ANY permissions:
|
|
1101
|
+
|
|
1102
|
+
* languageUnderstanding:nluDomainVersion:add
|
|
1103
|
+
* dialog:botVersion:add
|
|
1104
|
+
|
|
1105
|
+
|
|
1106
|
+
### Example
|
|
1107
|
+
```{"language":"ruby"}
|
|
1108
|
+
# load the gem
|
|
1109
|
+
require 'purecloudplatformclientv2'
|
|
1110
|
+
# setup authorization
|
|
1111
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1112
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1113
|
+
environment = "mypurecloud.com"
|
|
1114
|
+
|
|
1115
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1116
|
+
|
|
1117
|
+
PureCloud.configure do |config|
|
|
1118
|
+
config.access_token = @authToken
|
|
1119
|
+
end
|
|
1120
|
+
|
|
1121
|
+
api_instance = PureCloud::LanguageUnderstandingApi.new
|
|
1122
|
+
|
|
1123
|
+
domain_id = "domain_id_example" # String | ID of the NLU domain.
|
|
1124
|
+
|
|
1125
|
+
body = PureCloud::NluDomainVersion.new # NluDomainVersion | The NLU Domain Version to create.
|
|
1126
|
+
|
|
1127
|
+
|
|
1128
|
+
begin
|
|
1129
|
+
#Create an NLU Domain Version.
|
|
1130
|
+
result = api_instance.post_languageunderstanding_domain_versions(domain_id, body)
|
|
1131
|
+
p result
|
|
1132
|
+
rescue PureCloud::ApiError => e
|
|
1133
|
+
puts "Exception when calling LanguageUnderstandingApi->post_languageunderstanding_domain_versions: #{e}"
|
|
1134
|
+
end
|
|
1135
|
+
```
|
|
1136
|
+
|
|
1137
|
+
### Parameters
|
|
1138
|
+
|
|
1139
|
+
Name | Type | Description | Notes
|
|
1140
|
+
------------- | ------------- | ------------- | -------------
|
|
1141
|
+
**domain_id** | **String**| ID of the NLU domain. | |
|
|
1142
|
+
**body** | [**NluDomainVersion**](NluDomainVersion.html)| The NLU Domain Version to create. | |
|
|
1143
|
+
{: class="table table-striped"}
|
|
1144
|
+
|
|
1145
|
+
|
|
1146
|
+
### Return type
|
|
1147
|
+
|
|
1148
|
+
[**NluDomainVersion**](NluDomainVersion.html)
|
|
1149
|
+
|
|
1150
|
+
### HTTP request headers
|
|
1151
|
+
|
|
1152
|
+
- **Content-Type**: application/json
|
|
1153
|
+
- **Accept**: application/json
|
|
1154
|
+
|
|
1155
|
+
|
|
1156
|
+
|
|
1021
1157
|
<a name="post_languageunderstanding_domains"></a>
|
|
1022
1158
|
|
|
1023
|
-
## [**NluDomain**](NluDomain.html) post_languageunderstanding_domains(
|
|
1159
|
+
## [**NluDomain**](NluDomain.html) post_languageunderstanding_domains(body)
|
|
1024
1160
|
|
|
1025
1161
|
|
|
1026
1162
|
|
|
@@ -1053,13 +1189,12 @@ end
|
|
|
1053
1189
|
|
|
1054
1190
|
api_instance = PureCloud::LanguageUnderstandingApi.new
|
|
1055
1191
|
|
|
1056
|
-
|
|
1057
|
-
|
|
1058
|
-
}
|
|
1192
|
+
body = PureCloud::NluDomain.new # NluDomain | The NLU Domain to create.
|
|
1193
|
+
|
|
1059
1194
|
|
|
1060
1195
|
begin
|
|
1061
1196
|
#Create an NLU Domain.
|
|
1062
|
-
result = api_instance.post_languageunderstanding_domains(
|
|
1197
|
+
result = api_instance.post_languageunderstanding_domains(body)
|
|
1063
1198
|
p result
|
|
1064
1199
|
rescue PureCloud::ApiError => e
|
|
1065
1200
|
puts "Exception when calling LanguageUnderstandingApi->post_languageunderstanding_domains: #{e}"
|
|
@@ -1070,7 +1205,7 @@ end
|
|
|
1070
1205
|
|
|
1071
1206
|
Name | Type | Description | Notes
|
|
1072
1207
|
------------- | ------------- | ------------- | -------------
|
|
1073
|
-
**body** | [**NluDomain**](NluDomain.html)|
|
|
1208
|
+
**body** | [**NluDomain**](NluDomain.html)| The NLU Domain to create. | |
|
|
1074
1209
|
{: class="table table-striped"}
|
|
1075
1210
|
|
|
1076
1211
|
|
|
@@ -1087,7 +1222,7 @@ Name | Type | Description | Notes
|
|
|
1087
1222
|
|
|
1088
1223
|
<a name="put_languageunderstanding_domain_version"></a>
|
|
1089
1224
|
|
|
1090
|
-
## [**NluDomainVersion**](NluDomainVersion.html) put_languageunderstanding_domain_version(domain_id, domain_version_id,
|
|
1225
|
+
## [**NluDomainVersion**](NluDomainVersion.html) put_languageunderstanding_domain_version(domain_id, domain_version_id, body)
|
|
1091
1226
|
|
|
1092
1227
|
|
|
1093
1228
|
|
|
@@ -1124,13 +1259,12 @@ domain_id = "domain_id_example" # String | ID of the NLU domain.
|
|
|
1124
1259
|
|
|
1125
1260
|
domain_version_id = "domain_version_id_example" # String | ID of the NLU domain version.
|
|
1126
1261
|
|
|
1127
|
-
|
|
1128
|
-
|
|
1129
|
-
}
|
|
1262
|
+
body = PureCloud::NluDomainVersion.new # NluDomainVersion | The updated NLU Domain Version.
|
|
1263
|
+
|
|
1130
1264
|
|
|
1131
1265
|
begin
|
|
1132
1266
|
#Update an NLU Domain Version.
|
|
1133
|
-
result = api_instance.put_languageunderstanding_domain_version(domain_id, domain_version_id,
|
|
1267
|
+
result = api_instance.put_languageunderstanding_domain_version(domain_id, domain_version_id, body)
|
|
1134
1268
|
p result
|
|
1135
1269
|
rescue PureCloud::ApiError => e
|
|
1136
1270
|
puts "Exception when calling LanguageUnderstandingApi->put_languageunderstanding_domain_version: #{e}"
|
|
@@ -1143,7 +1277,7 @@ Name | Type | Description | Notes
|
|
|
1143
1277
|
------------- | ------------- | ------------- | -------------
|
|
1144
1278
|
**domain_id** | **String**| ID of the NLU domain. | |
|
|
1145
1279
|
**domain_version_id** | **String**| ID of the NLU domain version. | |
|
|
1146
|
-
**body** | [**NluDomainVersion**](NluDomainVersion.html)|
|
|
1280
|
+
**body** | [**NluDomainVersion**](NluDomainVersion.html)| The updated NLU Domain Version. | |
|
|
1147
1281
|
{: class="table table-striped"}
|
|
1148
1282
|
|
|
1149
1283
|
|