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
@@ -1861,6 +1861,71 @@ module PureCloud
|
|
1861
1861
|
return data, status_code, headers
|
1862
1862
|
end
|
1863
1863
|
|
1864
|
+
# Query for journey aggregates
|
1865
|
+
#
|
1866
|
+
# @param body query
|
1867
|
+
# @param [Hash] opts the optional parameters
|
1868
|
+
# @return [JourneyAggregateQueryResponse]
|
1869
|
+
def post_analytics_journeys_aggregates_query(body, opts = {})
|
1870
|
+
data, _status_code, _headers = post_analytics_journeys_aggregates_query_with_http_info(body, opts)
|
1871
|
+
return data
|
1872
|
+
end
|
1873
|
+
|
1874
|
+
# Query for journey aggregates
|
1875
|
+
#
|
1876
|
+
# @param body query
|
1877
|
+
# @param [Hash] opts the optional parameters
|
1878
|
+
# @return [Array<(JourneyAggregateQueryResponse, Fixnum, Hash)>] JourneyAggregateQueryResponse data, response status code and response headers
|
1879
|
+
def post_analytics_journeys_aggregates_query_with_http_info(body, opts = {})
|
1880
|
+
if @api_client.config.debugging
|
1881
|
+
@api_client.config.logger.debug "Calling API: AnalyticsApi.post_analytics_journeys_aggregates_query ..."
|
1882
|
+
end
|
1883
|
+
|
1884
|
+
|
1885
|
+
# verify the required parameter 'body' is set
|
1886
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling AnalyticsApi.post_analytics_journeys_aggregates_query" if body.nil?
|
1887
|
+
|
1888
|
+
|
1889
|
+
|
1890
|
+
|
1891
|
+
|
1892
|
+
# resource path
|
1893
|
+
local_var_path = "/api/v2/analytics/journeys/aggregates/query".sub('{format}','json')
|
1894
|
+
|
1895
|
+
# query parameters
|
1896
|
+
query_params = {}
|
1897
|
+
|
1898
|
+
# header parameters
|
1899
|
+
header_params = {}
|
1900
|
+
|
1901
|
+
# HTTP header 'Accept' (if needed)
|
1902
|
+
local_header_accept = ['application/json']
|
1903
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
1904
|
+
|
1905
|
+
# HTTP header 'Content-Type'
|
1906
|
+
local_header_content_type = ['application/json']
|
1907
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
1908
|
+
|
1909
|
+
# form parameters
|
1910
|
+
form_params = {}
|
1911
|
+
|
1912
|
+
# http body (model)
|
1913
|
+
post_body = @api_client.object_to_http_body(body)
|
1914
|
+
|
1915
|
+
auth_names = ['PureCloud OAuth']
|
1916
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
1917
|
+
:header_params => header_params,
|
1918
|
+
:query_params => query_params,
|
1919
|
+
:form_params => form_params,
|
1920
|
+
:body => post_body,
|
1921
|
+
:auth_names => auth_names,
|
1922
|
+
:return_type => 'JourneyAggregateQueryResponse')
|
1923
|
+
if @api_client.config.debugging
|
1924
|
+
@api_client.config.logger.debug "API called: AnalyticsApi#post_analytics_journeys_aggregates_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1925
|
+
end
|
1926
|
+
return data, status_code, headers
|
1927
|
+
end
|
1928
|
+
|
1864
1929
|
# Query for queue observations
|
1865
1930
|
#
|
1866
1931
|
# @param body query
|
@@ -1927,7 +1992,7 @@ module PureCloud
|
|
1927
1992
|
end
|
1928
1993
|
|
1929
1994
|
# Generate a view export request
|
1930
|
-
#
|
1995
|
+
# This API creates a reporting export but the desired way to export analytics data is to use the analytics query APIs instead
|
1931
1996
|
# @param body ReportingExportJobRequest
|
1932
1997
|
# @param [Hash] opts the optional parameters
|
1933
1998
|
# @return [ReportingExportJobResponse]
|
@@ -1937,7 +2002,7 @@ module PureCloud
|
|
1937
2002
|
end
|
1938
2003
|
|
1939
2004
|
# Generate a view export request
|
1940
|
-
#
|
2005
|
+
# This API creates a reporting export but the desired way to export analytics data is to use the analytics query APIs instead
|
1941
2006
|
# @param body ReportingExportJobRequest
|
1942
2007
|
# @param [Hash] opts the optional parameters
|
1943
2008
|
# @return [Array<(ReportingExportJobResponse, Fixnum, Hash)>] ReportingExportJobResponse data, response status code and response headers
|
@@ -1153,8 +1153,8 @@ module PureCloud
|
|
1153
1153
|
fail ArgumentError, "Missing the required parameter 'object_type' when calling ArchitectApi.get_architect_dependencytracking_consumedresources" if object_type.nil?
|
1154
1154
|
|
1155
1155
|
# verify enum value
|
1156
|
-
unless ['ACDLANGUAGE', 'ACDSKILL', 'ACDWRAPUPCODE', 'BOTFLOW', 'BRIDGEACTION', 'COMMONMODULEFLOW', 'COMPOSERSCRIPT', 'CONTACTLIST', 'DATAACTION', 'DATATABLE', 'DIALOGENGINEBOT', 'DIALOGENGINEBOTVERSION', 'DIALOGFLOWAGENT', 'EMAILROUTE', 'EMERGENCYGROUP', 'FLOWACTION', 'FLOWDATATYPE', 'FLOWOUTCOME', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDCHATFLOW', 'INBOUNDEMAILFLOW', 'INBOUNDSHORTMESSAGEFLOW', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'LEXBOT', 'LEXBOTALIAS', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RECORDINGPOLICY', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', 'SURVEYINVITEFLOW', 'SYSTEMPROMPT', 'TTSENGINE', 'TTSVOICE', 'USER', 'USERPROMPT', 'WIDGET', 'WORKFLOW'].include?(object_type)
|
1157
|
-
fail ArgumentError, "invalid value for 'object_type', must be one of ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BOTFLOW, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGENGINEBOT, DIALOGENGINEBOTVERSION, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWACTION, FLOWDATATYPE, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET, WORKFLOW"
|
1156
|
+
unless ['ACDLANGUAGE', 'ACDSKILL', 'ACDWRAPUPCODE', 'BOTFLOW', 'BRIDGEACTION', 'COMMONMODULEFLOW', 'COMPOSERSCRIPT', 'CONTACTLIST', 'DATAACTION', 'DATATABLE', 'DIALOGENGINEBOT', 'DIALOGENGINEBOTVERSION', 'DIALOGFLOWAGENT', 'EMAILROUTE', 'EMERGENCYGROUP', 'FLOWACTION', 'FLOWDATATYPE', 'FLOWOUTCOME', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDCHATFLOW', 'INBOUNDEMAILFLOW', 'INBOUNDSHORTMESSAGEFLOW', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'LEXBOT', 'LEXBOTALIAS', 'NLUDOMAIN', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RECORDINGPOLICY', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', 'SURVEYINVITEFLOW', 'SYSTEMPROMPT', 'TTSENGINE', 'TTSVOICE', 'USER', 'USERPROMPT', 'WIDGET', 'WORKFLOW'].include?(object_type)
|
1157
|
+
fail ArgumentError, "invalid value for 'object_type', must be one of ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BOTFLOW, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGENGINEBOT, DIALOGENGINEBOTVERSION, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWACTION, FLOWDATATYPE, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, NLUDOMAIN, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET, WORKFLOW"
|
1158
1158
|
end
|
1159
1159
|
|
1160
1160
|
|
@@ -1267,8 +1267,8 @@ module PureCloud
|
|
1267
1267
|
fail ArgumentError, "Missing the required parameter 'object_type' when calling ArchitectApi.get_architect_dependencytracking_consumingresources" if object_type.nil?
|
1268
1268
|
|
1269
1269
|
# verify enum value
|
1270
|
-
unless ['ACDLANGUAGE', 'ACDSKILL', 'ACDWRAPUPCODE', 'BOTFLOW', 'BRIDGEACTION', 'COMMONMODULEFLOW', 'COMPOSERSCRIPT', 'CONTACTLIST', 'DATAACTION', 'DATATABLE', 'DIALOGENGINEBOT', 'DIALOGENGINEBOTVERSION', 'DIALOGFLOWAGENT', 'EMAILROUTE', 'EMERGENCYGROUP', 'FLOWACTION', 'FLOWDATATYPE', 'FLOWOUTCOME', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDCHATFLOW', 'INBOUNDEMAILFLOW', 'INBOUNDSHORTMESSAGEFLOW', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'LEXBOT', 'LEXBOTALIAS', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RECORDINGPOLICY', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', 'SURVEYINVITEFLOW', 'SYSTEMPROMPT', 'TTSENGINE', 'TTSVOICE', 'USER', 'USERPROMPT', 'WIDGET', 'WORKFLOW'].include?(object_type)
|
1271
|
-
fail ArgumentError, "invalid value for 'object_type', must be one of ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BOTFLOW, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGENGINEBOT, DIALOGENGINEBOTVERSION, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWACTION, FLOWDATATYPE, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET, WORKFLOW"
|
1270
|
+
unless ['ACDLANGUAGE', 'ACDSKILL', 'ACDWRAPUPCODE', 'BOTFLOW', 'BRIDGEACTION', 'COMMONMODULEFLOW', 'COMPOSERSCRIPT', 'CONTACTLIST', 'DATAACTION', 'DATATABLE', 'DIALOGENGINEBOT', 'DIALOGENGINEBOTVERSION', 'DIALOGFLOWAGENT', 'EMAILROUTE', 'EMERGENCYGROUP', 'FLOWACTION', 'FLOWDATATYPE', 'FLOWOUTCOME', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDCHATFLOW', 'INBOUNDEMAILFLOW', 'INBOUNDSHORTMESSAGEFLOW', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'LEXBOT', 'LEXBOTALIAS', 'NLUDOMAIN', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RECORDINGPOLICY', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', 'SURVEYINVITEFLOW', 'SYSTEMPROMPT', 'TTSENGINE', 'TTSVOICE', 'USER', 'USERPROMPT', 'WIDGET', 'WORKFLOW'].include?(object_type)
|
1271
|
+
fail ArgumentError, "invalid value for 'object_type', must be one of ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BOTFLOW, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGENGINEBOT, DIALOGENGINEBOTVERSION, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWACTION, FLOWDATATYPE, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, NLUDOMAIN, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET, WORKFLOW"
|
1272
1272
|
end
|
1273
1273
|
|
1274
1274
|
|
@@ -1526,8 +1526,8 @@ module PureCloud
|
|
1526
1526
|
|
1527
1527
|
|
1528
1528
|
|
1529
|
-
if opts[:'object_type'] && !['ACDLANGUAGE', 'ACDSKILL', 'ACDWRAPUPCODE', 'BOTFLOW', 'BRIDGEACTION', 'COMMONMODULEFLOW', 'COMPOSERSCRIPT', 'CONTACTLIST', 'DATAACTION', 'DATATABLE', 'DIALOGENGINEBOT', 'DIALOGENGINEBOTVERSION', 'DIALOGFLOWAGENT', 'EMAILROUTE', 'EMERGENCYGROUP', 'FLOWACTION', 'FLOWDATATYPE', 'FLOWOUTCOME', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDCHATFLOW', 'INBOUNDEMAILFLOW', 'INBOUNDSHORTMESSAGEFLOW', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'LEXBOT', 'LEXBOTALIAS', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RECORDINGPOLICY', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', 'SURVEYINVITEFLOW', 'SYSTEMPROMPT', 'TTSENGINE', 'TTSVOICE', 'USER', 'USERPROMPT', 'WIDGET', 'WORKFLOW'].include?(opts[:'object_type'])
|
1530
|
-
fail ArgumentError, 'invalid value for "object_type", must be one of ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BOTFLOW, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGENGINEBOT, DIALOGENGINEBOTVERSION, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWACTION, FLOWDATATYPE, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET, WORKFLOW'
|
1529
|
+
if opts[:'object_type'] && !['ACDLANGUAGE', 'ACDSKILL', 'ACDWRAPUPCODE', 'BOTFLOW', 'BRIDGEACTION', 'COMMONMODULEFLOW', 'COMPOSERSCRIPT', 'CONTACTLIST', 'DATAACTION', 'DATATABLE', 'DIALOGENGINEBOT', 'DIALOGENGINEBOTVERSION', 'DIALOGFLOWAGENT', 'EMAILROUTE', 'EMERGENCYGROUP', 'FLOWACTION', 'FLOWDATATYPE', 'FLOWOUTCOME', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDCHATFLOW', 'INBOUNDEMAILFLOW', 'INBOUNDSHORTMESSAGEFLOW', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'LEXBOT', 'LEXBOTALIAS', 'NLUDOMAIN', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RECORDINGPOLICY', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', 'SURVEYINVITEFLOW', 'SYSTEMPROMPT', 'TTSENGINE', 'TTSVOICE', 'USER', 'USERPROMPT', 'WIDGET', 'WORKFLOW'].include?(opts[:'object_type'])
|
1530
|
+
fail ArgumentError, 'invalid value for "object_type", must be one of ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BOTFLOW, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGENGINEBOT, DIALOGENGINEBOTVERSION, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWACTION, FLOWDATATYPE, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, NLUDOMAIN, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET, WORKFLOW'
|
1531
1531
|
end
|
1532
1532
|
|
1533
1533
|
|
@@ -2788,6 +2788,7 @@ module PureCloud
|
|
2788
2788
|
# @option opts [String] :sort_by Sort by (default to name)
|
2789
2789
|
# @option opts [String] :sort_order Sort order (default to ASC)
|
2790
2790
|
# @option opts [String] :name Name of the Schedule Group to filter by.
|
2791
|
+
# @option opts [String] :schedule_ids A comma-delimited list of Schedule IDs to filter by.
|
2791
2792
|
# @return [ScheduleGroupEntityListing]
|
2792
2793
|
def get_architect_schedulegroups(opts = {})
|
2793
2794
|
data, _status_code, _headers = get_architect_schedulegroups_with_http_info(opts)
|
@@ -2802,6 +2803,7 @@ module PureCloud
|
|
2802
2803
|
# @option opts [String] :sort_by Sort by
|
2803
2804
|
# @option opts [String] :sort_order Sort order
|
2804
2805
|
# @option opts [String] :name Name of the Schedule Group to filter by.
|
2806
|
+
# @option opts [String] :schedule_ids A comma-delimited list of Schedule IDs to filter by.
|
2805
2807
|
# @return [Array<(ScheduleGroupEntityListing, Fixnum, Hash)>] ScheduleGroupEntityListing data, response status code and response headers
|
2806
2808
|
def get_architect_schedulegroups_with_http_info(opts = {})
|
2807
2809
|
if @api_client.config.debugging
|
@@ -2831,6 +2833,12 @@ module PureCloud
|
|
2831
2833
|
|
2832
2834
|
|
2833
2835
|
|
2836
|
+
|
2837
|
+
|
2838
|
+
|
2839
|
+
|
2840
|
+
|
2841
|
+
|
2834
2842
|
|
2835
2843
|
|
2836
2844
|
|
@@ -2848,6 +2856,7 @@ module PureCloud
|
|
2848
2856
|
query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
|
2849
2857
|
query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
|
2850
2858
|
query_params[:'name'] = opts[:'name'] if opts[:'name']
|
2859
|
+
query_params[:'scheduleIds'] = opts[:'schedule_ids'] if opts[:'schedule_ids']
|
2851
2860
|
|
2852
2861
|
# header parameters
|
2853
2862
|
header_params = {}
|
@@ -24,6 +24,61 @@ module PureCloud
|
|
24
24
|
@api_client = api_client
|
25
25
|
end
|
26
26
|
|
27
|
+
# Get service mapping information used in audits.
|
28
|
+
#
|
29
|
+
# @param [Hash] opts the optional parameters
|
30
|
+
# @return [AuditQueryServiceMapping]
|
31
|
+
def get_audits_query_realtime_servicemapping(opts = {})
|
32
|
+
data, _status_code, _headers = get_audits_query_realtime_servicemapping_with_http_info(opts)
|
33
|
+
return data
|
34
|
+
end
|
35
|
+
|
36
|
+
# Get service mapping information used in audits.
|
37
|
+
#
|
38
|
+
# @param [Hash] opts the optional parameters
|
39
|
+
# @return [Array<(AuditQueryServiceMapping, Fixnum, Hash)>] AuditQueryServiceMapping data, response status code and response headers
|
40
|
+
def get_audits_query_realtime_servicemapping_with_http_info(opts = {})
|
41
|
+
if @api_client.config.debugging
|
42
|
+
@api_client.config.logger.debug "Calling API: AuditApi.get_audits_query_realtime_servicemapping ..."
|
43
|
+
end
|
44
|
+
|
45
|
+
# resource path
|
46
|
+
local_var_path = "/api/v2/audits/query/realtime/servicemapping".sub('{format}','json')
|
47
|
+
|
48
|
+
# query parameters
|
49
|
+
query_params = {}
|
50
|
+
|
51
|
+
# header parameters
|
52
|
+
header_params = {}
|
53
|
+
|
54
|
+
# HTTP header 'Accept' (if needed)
|
55
|
+
local_header_accept = ['application/json']
|
56
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
57
|
+
|
58
|
+
# HTTP header 'Content-Type'
|
59
|
+
local_header_content_type = ['application/json']
|
60
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
61
|
+
|
62
|
+
# form parameters
|
63
|
+
form_params = {}
|
64
|
+
|
65
|
+
# http body (model)
|
66
|
+
post_body = nil
|
67
|
+
|
68
|
+
auth_names = ['PureCloud OAuth']
|
69
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
70
|
+
:header_params => header_params,
|
71
|
+
:query_params => query_params,
|
72
|
+
:form_params => form_params,
|
73
|
+
:body => post_body,
|
74
|
+
:auth_names => auth_names,
|
75
|
+
:return_type => 'AuditQueryServiceMapping')
|
76
|
+
if @api_client.config.debugging
|
77
|
+
@api_client.config.logger.debug "API called: AuditApi#get_audits_query_realtime_servicemapping\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
78
|
+
end
|
79
|
+
return data, status_code, headers
|
80
|
+
end
|
81
|
+
|
27
82
|
# Get service mapping information used in audits.
|
28
83
|
#
|
29
84
|
# @param [Hash] opts the optional parameters
|
@@ -300,5 +355,79 @@ module PureCloud
|
|
300
355
|
end
|
301
356
|
return data, status_code, headers
|
302
357
|
end
|
358
|
+
|
359
|
+
# This endpoint will only retrieve 7 days worth of audits for certain services. Please use /query to get a full list and older audits.
|
360
|
+
#
|
361
|
+
# @param body query
|
362
|
+
# @param [Hash] opts the optional parameters
|
363
|
+
# @option opts [Array<String>] :expand Which fields, if any, to expand
|
364
|
+
# @return [AuditRealtimeQueryResultsResponse]
|
365
|
+
def post_audits_query_realtime(body, opts = {})
|
366
|
+
data, _status_code, _headers = post_audits_query_realtime_with_http_info(body, opts)
|
367
|
+
return data
|
368
|
+
end
|
369
|
+
|
370
|
+
# This endpoint will only retrieve 7 days worth of audits for certain services. Please use /query to get a full list and older audits.
|
371
|
+
#
|
372
|
+
# @param body query
|
373
|
+
# @param [Hash] opts the optional parameters
|
374
|
+
# @option opts [Array<String>] :expand Which fields, if any, to expand
|
375
|
+
# @return [Array<(AuditRealtimeQueryResultsResponse, Fixnum, Hash)>] AuditRealtimeQueryResultsResponse data, response status code and response headers
|
376
|
+
def post_audits_query_realtime_with_http_info(body, opts = {})
|
377
|
+
if @api_client.config.debugging
|
378
|
+
@api_client.config.logger.debug "Calling API: AuditApi.post_audits_query_realtime ..."
|
379
|
+
end
|
380
|
+
|
381
|
+
|
382
|
+
# verify the required parameter 'body' is set
|
383
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling AuditApi.post_audits_query_realtime" if body.nil?
|
384
|
+
|
385
|
+
|
386
|
+
|
387
|
+
|
388
|
+
|
389
|
+
|
390
|
+
|
391
|
+
|
392
|
+
|
393
|
+
|
394
|
+
|
395
|
+
# resource path
|
396
|
+
local_var_path = "/api/v2/audits/query/realtime".sub('{format}','json')
|
397
|
+
|
398
|
+
# query parameters
|
399
|
+
query_params = {}
|
400
|
+
query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
|
401
|
+
|
402
|
+
# header parameters
|
403
|
+
header_params = {}
|
404
|
+
|
405
|
+
# HTTP header 'Accept' (if needed)
|
406
|
+
local_header_accept = ['application/json']
|
407
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
408
|
+
|
409
|
+
# HTTP header 'Content-Type'
|
410
|
+
local_header_content_type = ['application/json']
|
411
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
412
|
+
|
413
|
+
# form parameters
|
414
|
+
form_params = {}
|
415
|
+
|
416
|
+
# http body (model)
|
417
|
+
post_body = @api_client.object_to_http_body(body)
|
418
|
+
|
419
|
+
auth_names = ['PureCloud OAuth']
|
420
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
421
|
+
:header_params => header_params,
|
422
|
+
:query_params => query_params,
|
423
|
+
:form_params => form_params,
|
424
|
+
:body => post_body,
|
425
|
+
:auth_names => auth_names,
|
426
|
+
:return_type => 'AuditRealtimeQueryResultsResponse')
|
427
|
+
if @api_client.config.debugging
|
428
|
+
@api_client.config.logger.debug "API called: AuditApi#post_audits_query_realtime\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
429
|
+
end
|
430
|
+
return data, status_code, headers
|
431
|
+
end
|
303
432
|
end
|
304
433
|
end
|
@@ -28,17 +28,17 @@ module PureCloud
|
|
28
28
|
# Permission not required if you are the creator of the appointment
|
29
29
|
# @param appointment_id The ID of the coaching appointment.
|
30
30
|
# @param [Hash] opts the optional parameters
|
31
|
-
# @return [
|
31
|
+
# @return [CoachingAppointmentReference]
|
32
32
|
def delete_coaching_appointment(appointment_id, opts = {})
|
33
|
-
delete_coaching_appointment_with_http_info(appointment_id, opts)
|
34
|
-
return
|
33
|
+
data, _status_code, _headers = delete_coaching_appointment_with_http_info(appointment_id, opts)
|
34
|
+
return data
|
35
35
|
end
|
36
36
|
|
37
37
|
# Delete an existing appointment
|
38
38
|
# Permission not required if you are the creator of the appointment
|
39
39
|
# @param appointment_id The ID of the coaching appointment.
|
40
40
|
# @param [Hash] opts the optional parameters
|
41
|
-
# @return [Array<(
|
41
|
+
# @return [Array<(CoachingAppointmentReference, Fixnum, Hash)>] CoachingAppointmentReference data, response status code and response headers
|
42
42
|
def delete_coaching_appointment_with_http_info(appointment_id, opts = {})
|
43
43
|
if @api_client.config.debugging
|
44
44
|
@api_client.config.logger.debug "Calling API: CoachingApi.delete_coaching_appointment ..."
|
@@ -81,7 +81,8 @@ module PureCloud
|
|
81
81
|
:query_params => query_params,
|
82
82
|
:form_params => form_params,
|
83
83
|
:body => post_body,
|
84
|
-
:auth_names => auth_names
|
84
|
+
:auth_names => auth_names,
|
85
|
+
:return_type => 'CoachingAppointmentReference')
|
85
86
|
if @api_client.config.debugging
|
86
87
|
@api_client.config.logger.debug "API called: CoachingApi#delete_coaching_appointment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
87
88
|
end
|
@@ -472,12 +473,15 @@ module PureCloud
|
|
472
473
|
#
|
473
474
|
# @param user_ids The user IDs for which to retrieve appointments
|
474
475
|
# @param [Hash] opts the optional parameters
|
475
|
-
# @option opts [String] :interval Interval
|
476
|
+
# @option opts [String] :interval Interval to filter data by. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
|
476
477
|
# @option opts [Integer] :page_number Page number (default to 1)
|
477
478
|
# @option opts [Integer] :page_size Page size (default to 25)
|
478
479
|
# @option opts [Array<String>] :statuses Appointment Statuses to filter by
|
479
480
|
# @option opts [Array<String>] :facilitator_ids The facilitator IDs for which to retrieve appointments
|
480
481
|
# @option opts [String] :sort_order Sort (by due date) either Asc or Desc
|
482
|
+
# @option opts [Array<String>] :relationships Relationships to filter by
|
483
|
+
# @option opts [String] :completion_interval Appointment completion start and end to filter by. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
|
484
|
+
# @option opts [String] :overdue Overdue status to filter by
|
481
485
|
# @return [CoachingAppointmentResponseList]
|
482
486
|
def get_coaching_appointments(user_ids, opts = {})
|
483
487
|
data, _status_code, _headers = get_coaching_appointments_with_http_info(user_ids, opts)
|
@@ -488,12 +492,15 @@ module PureCloud
|
|
488
492
|
#
|
489
493
|
# @param user_ids The user IDs for which to retrieve appointments
|
490
494
|
# @param [Hash] opts the optional parameters
|
491
|
-
# @option opts [String] :interval Interval
|
495
|
+
# @option opts [String] :interval Interval to filter data by. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
|
492
496
|
# @option opts [Integer] :page_number Page number
|
493
497
|
# @option opts [Integer] :page_size Page size
|
494
498
|
# @option opts [Array<String>] :statuses Appointment Statuses to filter by
|
495
499
|
# @option opts [Array<String>] :facilitator_ids The facilitator IDs for which to retrieve appointments
|
496
500
|
# @option opts [String] :sort_order Sort (by due date) either Asc or Desc
|
501
|
+
# @option opts [Array<String>] :relationships Relationships to filter by
|
502
|
+
# @option opts [String] :completion_interval Appointment completion start and end to filter by. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
|
503
|
+
# @option opts [String] :overdue Overdue status to filter by
|
497
504
|
# @return [Array<(CoachingAppointmentResponseList, Fixnum, Hash)>] CoachingAppointmentResponseList data, response status code and response headers
|
498
505
|
def get_coaching_appointments_with_http_info(user_ids, opts = {})
|
499
506
|
if @api_client.config.debugging
|
@@ -548,6 +555,28 @@ module PureCloud
|
|
548
555
|
|
549
556
|
|
550
557
|
|
558
|
+
|
559
|
+
|
560
|
+
|
561
|
+
|
562
|
+
|
563
|
+
|
564
|
+
|
565
|
+
|
566
|
+
|
567
|
+
|
568
|
+
|
569
|
+
|
570
|
+
|
571
|
+
|
572
|
+
|
573
|
+
if opts[:'overdue'] && !['Any', 'True', 'False'].include?(opts[:'overdue'])
|
574
|
+
fail ArgumentError, 'invalid value for "overdue", must be one of Any, True, False'
|
575
|
+
end
|
576
|
+
|
577
|
+
|
578
|
+
|
579
|
+
|
551
580
|
# resource path
|
552
581
|
local_var_path = "/api/v2/coaching/appointments".sub('{format}','json')
|
553
582
|
|
@@ -560,6 +589,9 @@ module PureCloud
|
|
560
589
|
query_params[:'statuses'] = @api_client.build_collection_param(opts[:'statuses'], :multi) if opts[:'statuses']
|
561
590
|
query_params[:'facilitatorIds'] = @api_client.build_collection_param(opts[:'facilitator_ids'], :multi) if opts[:'facilitator_ids']
|
562
591
|
query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
|
592
|
+
query_params[:'relationships'] = @api_client.build_collection_param(opts[:'relationships'], :multi) if opts[:'relationships']
|
593
|
+
query_params[:'completionInterval'] = opts[:'completion_interval'] if opts[:'completion_interval']
|
594
|
+
query_params[:'overdue'] = opts[:'overdue'] if opts[:'overdue']
|
563
595
|
|
564
596
|
# header parameters
|
565
597
|
header_params = {}
|
@@ -595,12 +627,15 @@ module PureCloud
|
|
595
627
|
# Get my appointments for a given date range
|
596
628
|
#
|
597
629
|
# @param [Hash] opts the optional parameters
|
598
|
-
# @option opts [String] :interval Interval
|
630
|
+
# @option opts [String] :interval Interval to filter data by. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
|
599
631
|
# @option opts [Integer] :page_number Page number (default to 1)
|
600
632
|
# @option opts [Integer] :page_size Page size (default to 25)
|
601
633
|
# @option opts [Array<String>] :statuses Appointment Statuses to filter by
|
602
634
|
# @option opts [Array<String>] :facilitator_ids The facilitator IDs for which to retrieve appointments
|
603
635
|
# @option opts [String] :sort_order Sort (by due date) either Asc or Desc
|
636
|
+
# @option opts [Array<String>] :relationships Relationships to filter by
|
637
|
+
# @option opts [String] :completion_interval Appointment completion start and end to filter by. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
|
638
|
+
# @option opts [String] :overdue Overdue status to filter by
|
604
639
|
# @return [CoachingAppointmentResponseList]
|
605
640
|
def get_coaching_appointments_me(opts = {})
|
606
641
|
data, _status_code, _headers = get_coaching_appointments_me_with_http_info(opts)
|
@@ -610,12 +645,15 @@ module PureCloud
|
|
610
645
|
# Get my appointments for a given date range
|
611
646
|
#
|
612
647
|
# @param [Hash] opts the optional parameters
|
613
|
-
# @option opts [String] :interval Interval
|
648
|
+
# @option opts [String] :interval Interval to filter data by. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
|
614
649
|
# @option opts [Integer] :page_number Page number
|
615
650
|
# @option opts [Integer] :page_size Page size
|
616
651
|
# @option opts [Array<String>] :statuses Appointment Statuses to filter by
|
617
652
|
# @option opts [Array<String>] :facilitator_ids The facilitator IDs for which to retrieve appointments
|
618
653
|
# @option opts [String] :sort_order Sort (by due date) either Asc or Desc
|
654
|
+
# @option opts [Array<String>] :relationships Relationships to filter by
|
655
|
+
# @option opts [String] :completion_interval Appointment completion start and end to filter by. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
|
656
|
+
# @option opts [String] :overdue Overdue status to filter by
|
619
657
|
# @return [Array<(CoachingAppointmentResponseList, Fixnum, Hash)>] CoachingAppointmentResponseList data, response status code and response headers
|
620
658
|
def get_coaching_appointments_me_with_http_info(opts = {})
|
621
659
|
if @api_client.config.debugging
|
@@ -662,6 +700,28 @@ module PureCloud
|
|
662
700
|
|
663
701
|
|
664
702
|
|
703
|
+
|
704
|
+
|
705
|
+
|
706
|
+
|
707
|
+
|
708
|
+
|
709
|
+
|
710
|
+
|
711
|
+
|
712
|
+
|
713
|
+
|
714
|
+
|
715
|
+
|
716
|
+
|
717
|
+
|
718
|
+
if opts[:'overdue'] && !['Any', 'True', 'False'].include?(opts[:'overdue'])
|
719
|
+
fail ArgumentError, 'invalid value for "overdue", must be one of Any, True, False'
|
720
|
+
end
|
721
|
+
|
722
|
+
|
723
|
+
|
724
|
+
|
665
725
|
# resource path
|
666
726
|
local_var_path = "/api/v2/coaching/appointments/me".sub('{format}','json')
|
667
727
|
|
@@ -673,6 +733,9 @@ module PureCloud
|
|
673
733
|
query_params[:'statuses'] = @api_client.build_collection_param(opts[:'statuses'], :multi) if opts[:'statuses']
|
674
734
|
query_params[:'facilitatorIds'] = @api_client.build_collection_param(opts[:'facilitator_ids'], :multi) if opts[:'facilitator_ids']
|
675
735
|
query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
|
736
|
+
query_params[:'relationships'] = @api_client.build_collection_param(opts[:'relationships'], :multi) if opts[:'relationships']
|
737
|
+
query_params[:'completionInterval'] = opts[:'completion_interval'] if opts[:'completion_interval']
|
738
|
+
query_params[:'overdue'] = opts[:'overdue'] if opts[:'overdue']
|
676
739
|
|
677
740
|
# header parameters
|
678
741
|
header_params = {}
|
@@ -709,6 +772,7 @@ module PureCloud
|
|
709
772
|
# Permission not required if you are the owner of the notification.
|
710
773
|
# @param notification_id The ID of the notification.
|
711
774
|
# @param [Hash] opts the optional parameters
|
775
|
+
# @option opts [Array<String>] :expand Indicates a field in the response which should be expanded.
|
712
776
|
# @return [CoachingNotification]
|
713
777
|
def get_coaching_notification(notification_id, opts = {})
|
714
778
|
data, _status_code, _headers = get_coaching_notification_with_http_info(notification_id, opts)
|
@@ -719,6 +783,7 @@ module PureCloud
|
|
719
783
|
# Permission not required if you are the owner of the notification.
|
720
784
|
# @param notification_id The ID of the notification.
|
721
785
|
# @param [Hash] opts the optional parameters
|
786
|
+
# @option opts [Array<String>] :expand Indicates a field in the response which should be expanded.
|
722
787
|
# @return [Array<(CoachingNotification, Fixnum, Hash)>] CoachingNotification data, response status code and response headers
|
723
788
|
def get_coaching_notification_with_http_info(notification_id, opts = {})
|
724
789
|
if @api_client.config.debugging
|
@@ -733,11 +798,18 @@ module PureCloud
|
|
733
798
|
|
734
799
|
|
735
800
|
|
801
|
+
|
802
|
+
|
803
|
+
|
804
|
+
|
805
|
+
|
806
|
+
|
736
807
|
# resource path
|
737
808
|
local_var_path = "/api/v2/coaching/notifications/{notificationId}".sub('{format}','json').sub('{' + 'notificationId' + '}', notification_id.to_s)
|
738
809
|
|
739
810
|
# query parameters
|
740
811
|
query_params = {}
|
812
|
+
query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
|
741
813
|
|
742
814
|
# header parameters
|
743
815
|
header_params = {}
|
@@ -775,6 +847,7 @@ module PureCloud
|
|
775
847
|
# @param [Hash] opts the optional parameters
|
776
848
|
# @option opts [Integer] :page_number Page number (default to 1)
|
777
849
|
# @option opts [Integer] :page_size Page size (default to 25)
|
850
|
+
# @option opts [Array<String>] :expand Indicates a field in the response which should be expanded.
|
778
851
|
# @return [CoachingNotificationList]
|
779
852
|
def get_coaching_notifications(opts = {})
|
780
853
|
data, _status_code, _headers = get_coaching_notifications_with_http_info(opts)
|
@@ -786,6 +859,7 @@ module PureCloud
|
|
786
859
|
# @param [Hash] opts the optional parameters
|
787
860
|
# @option opts [Integer] :page_number Page number
|
788
861
|
# @option opts [Integer] :page_size Page size
|
862
|
+
# @option opts [Array<String>] :expand Indicates a field in the response which should be expanded.
|
789
863
|
# @return [Array<(CoachingNotificationList, Fixnum, Hash)>] CoachingNotificationList data, response status code and response headers
|
790
864
|
def get_coaching_notifications_with_http_info(opts = {})
|
791
865
|
if @api_client.config.debugging
|
@@ -804,6 +878,12 @@ module PureCloud
|
|
804
878
|
|
805
879
|
|
806
880
|
|
881
|
+
|
882
|
+
|
883
|
+
|
884
|
+
|
885
|
+
|
886
|
+
|
807
887
|
# resource path
|
808
888
|
local_var_path = "/api/v2/coaching/notifications".sub('{format}','json')
|
809
889
|
|
@@ -811,6 +891,7 @@ module PureCloud
|
|
811
891
|
query_params = {}
|
812
892
|
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
|
813
893
|
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
|
894
|
+
query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
|
814
895
|
|
815
896
|
# header parameters
|
816
897
|
header_params = {}
|
@@ -1292,5 +1373,70 @@ module PureCloud
|
|
1292
1373
|
end
|
1293
1374
|
return data, status_code, headers
|
1294
1375
|
end
|
1376
|
+
|
1377
|
+
# Retrieve aggregated appointment data
|
1378
|
+
#
|
1379
|
+
# @param body Aggregate Request
|
1380
|
+
# @param [Hash] opts the optional parameters
|
1381
|
+
# @return [CoachingAppointmentAggregateResponse]
|
1382
|
+
def post_coaching_appointments_aggregates_query(body, opts = {})
|
1383
|
+
data, _status_code, _headers = post_coaching_appointments_aggregates_query_with_http_info(body, opts)
|
1384
|
+
return data
|
1385
|
+
end
|
1386
|
+
|
1387
|
+
# Retrieve aggregated appointment data
|
1388
|
+
#
|
1389
|
+
# @param body Aggregate Request
|
1390
|
+
# @param [Hash] opts the optional parameters
|
1391
|
+
# @return [Array<(CoachingAppointmentAggregateResponse, Fixnum, Hash)>] CoachingAppointmentAggregateResponse data, response status code and response headers
|
1392
|
+
def post_coaching_appointments_aggregates_query_with_http_info(body, opts = {})
|
1393
|
+
if @api_client.config.debugging
|
1394
|
+
@api_client.config.logger.debug "Calling API: CoachingApi.post_coaching_appointments_aggregates_query ..."
|
1395
|
+
end
|
1396
|
+
|
1397
|
+
|
1398
|
+
# verify the required parameter 'body' is set
|
1399
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling CoachingApi.post_coaching_appointments_aggregates_query" if body.nil?
|
1400
|
+
|
1401
|
+
|
1402
|
+
|
1403
|
+
|
1404
|
+
|
1405
|
+
# resource path
|
1406
|
+
local_var_path = "/api/v2/coaching/appointments/aggregates/query".sub('{format}','json')
|
1407
|
+
|
1408
|
+
# query parameters
|
1409
|
+
query_params = {}
|
1410
|
+
|
1411
|
+
# header parameters
|
1412
|
+
header_params = {}
|
1413
|
+
|
1414
|
+
# HTTP header 'Accept' (if needed)
|
1415
|
+
local_header_accept = ['application/json']
|
1416
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
1417
|
+
|
1418
|
+
# HTTP header 'Content-Type'
|
1419
|
+
local_header_content_type = ['application/json']
|
1420
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
1421
|
+
|
1422
|
+
# form parameters
|
1423
|
+
form_params = {}
|
1424
|
+
|
1425
|
+
# http body (model)
|
1426
|
+
post_body = @api_client.object_to_http_body(body)
|
1427
|
+
|
1428
|
+
auth_names = ['PureCloud OAuth']
|
1429
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
1430
|
+
:header_params => header_params,
|
1431
|
+
:query_params => query_params,
|
1432
|
+
:form_params => form_params,
|
1433
|
+
:body => post_body,
|
1434
|
+
:auth_names => auth_names,
|
1435
|
+
:return_type => 'CoachingAppointmentAggregateResponse')
|
1436
|
+
if @api_client.config.debugging
|
1437
|
+
@api_client.config.logger.debug "API called: CoachingApi#post_coaching_appointments_aggregates_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1438
|
+
end
|
1439
|
+
return data, status_code, headers
|
1440
|
+
end
|
1295
1441
|
end
|
1296
1442
|
end
|