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
@@ -479,6 +479,7 @@ module PureCloud
|
|
479
479
|
# @param q64 q64
|
480
480
|
# @param [Hash] opts the optional parameters
|
481
481
|
# @option opts [Array<String>] :expand expand
|
482
|
+
# @option opts [String] :integration_presence_source integrationPresenceSource
|
482
483
|
# @return [UsersSearchResponse]
|
483
484
|
def get_users_search(q64, opts = {})
|
484
485
|
data, _status_code, _headers = get_users_search_with_http_info(q64, opts)
|
@@ -490,6 +491,7 @@ module PureCloud
|
|
490
491
|
# @param q64 q64
|
491
492
|
# @param [Hash] opts the optional parameters
|
492
493
|
# @option opts [Array<String>] :expand expand
|
494
|
+
# @option opts [String] :integration_presence_source integrationPresenceSource
|
493
495
|
# @return [Array<(UsersSearchResponse, Fixnum, Hash)>] UsersSearchResponse data, response status code and response headers
|
494
496
|
def get_users_search_with_http_info(q64, opts = {})
|
495
497
|
if @api_client.config.debugging
|
@@ -510,6 +512,16 @@ module PureCloud
|
|
510
512
|
|
511
513
|
|
512
514
|
|
515
|
+
|
516
|
+
|
517
|
+
|
518
|
+
if opts[:'integration_presence_source'] && !['MicrosoftTeams', 'ZoomPhone'].include?(opts[:'integration_presence_source'])
|
519
|
+
fail ArgumentError, 'invalid value for "integration_presence_source", must be one of MicrosoftTeams, ZoomPhone'
|
520
|
+
end
|
521
|
+
|
522
|
+
|
523
|
+
|
524
|
+
|
513
525
|
# resource path
|
514
526
|
local_var_path = "/api/v2/users/search".sub('{format}','json')
|
515
527
|
|
@@ -517,6 +529,7 @@ module PureCloud
|
|
517
529
|
query_params = {}
|
518
530
|
query_params[:'q64'] = q64
|
519
531
|
query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
|
532
|
+
query_params[:'integrationPresenceSource'] = opts[:'integration_presence_source'] if opts[:'integration_presence_source']
|
520
533
|
|
521
534
|
# header parameters
|
522
535
|
header_params = {}
|
@@ -0,0 +1,167 @@
|
|
1
|
+
=begin
|
2
|
+
PureCloud Platform API
|
3
|
+
|
4
|
+
With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
|
5
|
+
|
6
|
+
OpenAPI spec version: v2
|
7
|
+
Contact: DeveloperEvangelists@genesys.com
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
|
10
|
+
License: UNLICENSED
|
11
|
+
https://help.mypurecloud.com/articles/terms-and-conditions/
|
12
|
+
|
13
|
+
Terms of Service: https://help.mypurecloud.com/articles/terms-and-conditions/
|
14
|
+
|
15
|
+
=end
|
16
|
+
|
17
|
+
require "uri"
|
18
|
+
|
19
|
+
module PureCloud
|
20
|
+
class SpeechTextAnalyticsApi
|
21
|
+
attr_accessor :api_client
|
22
|
+
|
23
|
+
def initialize(api_client = ApiClient.default)
|
24
|
+
@api_client = api_client
|
25
|
+
end
|
26
|
+
|
27
|
+
# Get Speech and Text Analytics for a specific conversation
|
28
|
+
#
|
29
|
+
# @param conversation_id Conversation Id
|
30
|
+
# @param [Hash] opts the optional parameters
|
31
|
+
# @return [ConversationMetrics]
|
32
|
+
def get_speechandtextanalytics_conversation(conversation_id, opts = {})
|
33
|
+
data, _status_code, _headers = get_speechandtextanalytics_conversation_with_http_info(conversation_id, opts)
|
34
|
+
return data
|
35
|
+
end
|
36
|
+
|
37
|
+
# Get Speech and Text Analytics for a specific conversation
|
38
|
+
#
|
39
|
+
# @param conversation_id Conversation Id
|
40
|
+
# @param [Hash] opts the optional parameters
|
41
|
+
# @return [Array<(ConversationMetrics, Fixnum, Hash)>] ConversationMetrics data, response status code and response headers
|
42
|
+
def get_speechandtextanalytics_conversation_with_http_info(conversation_id, opts = {})
|
43
|
+
if @api_client.config.debugging
|
44
|
+
@api_client.config.logger.debug "Calling API: SpeechTextAnalyticsApi.get_speechandtextanalytics_conversation ..."
|
45
|
+
end
|
46
|
+
|
47
|
+
|
48
|
+
# verify the required parameter 'conversation_id' is set
|
49
|
+
fail ArgumentError, "Missing the required parameter 'conversation_id' when calling SpeechTextAnalyticsApi.get_speechandtextanalytics_conversation" if conversation_id.nil?
|
50
|
+
|
51
|
+
|
52
|
+
|
53
|
+
|
54
|
+
|
55
|
+
# resource path
|
56
|
+
local_var_path = "/api/v2/speechandtextanalytics/conversations/{conversationId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s)
|
57
|
+
|
58
|
+
# query parameters
|
59
|
+
query_params = {}
|
60
|
+
|
61
|
+
# header parameters
|
62
|
+
header_params = {}
|
63
|
+
|
64
|
+
# HTTP header 'Accept' (if needed)
|
65
|
+
local_header_accept = ['application/json']
|
66
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
67
|
+
|
68
|
+
# HTTP header 'Content-Type'
|
69
|
+
local_header_content_type = ['application/json']
|
70
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
71
|
+
|
72
|
+
# form parameters
|
73
|
+
form_params = {}
|
74
|
+
|
75
|
+
# http body (model)
|
76
|
+
post_body = nil
|
77
|
+
|
78
|
+
auth_names = ['PureCloud OAuth']
|
79
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
80
|
+
:header_params => header_params,
|
81
|
+
:query_params => query_params,
|
82
|
+
:form_params => form_params,
|
83
|
+
:body => post_body,
|
84
|
+
:auth_names => auth_names,
|
85
|
+
:return_type => 'ConversationMetrics')
|
86
|
+
if @api_client.config.debugging
|
87
|
+
@api_client.config.logger.debug "API called: SpeechTextAnalyticsApi#get_speechandtextanalytics_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
88
|
+
end
|
89
|
+
return data, status_code, headers
|
90
|
+
end
|
91
|
+
|
92
|
+
# Get the pre-signed S3 URL for the transcript of a specific communication of a conversation
|
93
|
+
#
|
94
|
+
# @param conversation_id Conversation ID
|
95
|
+
# @param communication_id Communication ID
|
96
|
+
# @param [Hash] opts the optional parameters
|
97
|
+
# @return [TranscriptUrl]
|
98
|
+
def get_speechandtextanalytics_conversation_communication_transcripturl(conversation_id, communication_id, opts = {})
|
99
|
+
data, _status_code, _headers = get_speechandtextanalytics_conversation_communication_transcripturl_with_http_info(conversation_id, communication_id, opts)
|
100
|
+
return data
|
101
|
+
end
|
102
|
+
|
103
|
+
# Get the pre-signed S3 URL for the transcript of a specific communication of a conversation
|
104
|
+
#
|
105
|
+
# @param conversation_id Conversation ID
|
106
|
+
# @param communication_id Communication ID
|
107
|
+
# @param [Hash] opts the optional parameters
|
108
|
+
# @return [Array<(TranscriptUrl, Fixnum, Hash)>] TranscriptUrl data, response status code and response headers
|
109
|
+
def get_speechandtextanalytics_conversation_communication_transcripturl_with_http_info(conversation_id, communication_id, opts = {})
|
110
|
+
if @api_client.config.debugging
|
111
|
+
@api_client.config.logger.debug "Calling API: SpeechTextAnalyticsApi.get_speechandtextanalytics_conversation_communication_transcripturl ..."
|
112
|
+
end
|
113
|
+
|
114
|
+
|
115
|
+
# verify the required parameter 'conversation_id' is set
|
116
|
+
fail ArgumentError, "Missing the required parameter 'conversation_id' when calling SpeechTextAnalyticsApi.get_speechandtextanalytics_conversation_communication_transcripturl" if conversation_id.nil?
|
117
|
+
|
118
|
+
|
119
|
+
|
120
|
+
|
121
|
+
|
122
|
+
|
123
|
+
# verify the required parameter 'communication_id' is set
|
124
|
+
fail ArgumentError, "Missing the required parameter 'communication_id' when calling SpeechTextAnalyticsApi.get_speechandtextanalytics_conversation_communication_transcripturl" if communication_id.nil?
|
125
|
+
|
126
|
+
|
127
|
+
|
128
|
+
|
129
|
+
|
130
|
+
# resource path
|
131
|
+
local_var_path = "/api/v2/speechandtextanalytics/conversations/{conversationId}/communications/{communicationId}/transcripturl".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'communicationId' + '}', communication_id.to_s)
|
132
|
+
|
133
|
+
# query parameters
|
134
|
+
query_params = {}
|
135
|
+
|
136
|
+
# header parameters
|
137
|
+
header_params = {}
|
138
|
+
|
139
|
+
# HTTP header 'Accept' (if needed)
|
140
|
+
local_header_accept = ['application/json']
|
141
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
142
|
+
|
143
|
+
# HTTP header 'Content-Type'
|
144
|
+
local_header_content_type = ['application/json']
|
145
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
146
|
+
|
147
|
+
# form parameters
|
148
|
+
form_params = {}
|
149
|
+
|
150
|
+
# http body (model)
|
151
|
+
post_body = nil
|
152
|
+
|
153
|
+
auth_names = ['PureCloud OAuth']
|
154
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
155
|
+
:header_params => header_params,
|
156
|
+
:query_params => query_params,
|
157
|
+
:form_params => form_params,
|
158
|
+
:body => post_body,
|
159
|
+
:auth_names => auth_names,
|
160
|
+
:return_type => 'TranscriptUrl')
|
161
|
+
if @api_client.config.debugging
|
162
|
+
@api_client.config.logger.debug "API called: SpeechTextAnalyticsApi#get_speechandtextanalytics_conversation_communication_transcripturl\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
163
|
+
end
|
164
|
+
return data, status_code, headers
|
165
|
+
end
|
166
|
+
end
|
167
|
+
end
|
@@ -3001,6 +3001,7 @@ module PureCloud
|
|
3001
3001
|
# @option opts [Integer] :page_size Page size (default to 25)
|
3002
3002
|
# @option opts [Integer] :page_number Page number (default to 1)
|
3003
3003
|
# @option opts [String] :sort_by Sort by (default to number)
|
3004
|
+
# @option opts [Array<String>] :id Filter by a specific list of ID's
|
3004
3005
|
# @return [DIDPoolEntityListing]
|
3005
3006
|
def get_telephony_providers_edges_didpools(opts = {})
|
3006
3007
|
data, _status_code, _headers = get_telephony_providers_edges_didpools_with_http_info(opts)
|
@@ -3013,6 +3014,7 @@ module PureCloud
|
|
3013
3014
|
# @option opts [Integer] :page_size Page size
|
3014
3015
|
# @option opts [Integer] :page_number Page number
|
3015
3016
|
# @option opts [String] :sort_by Sort by
|
3017
|
+
# @option opts [Array<String>] :id Filter by a specific list of ID's
|
3016
3018
|
# @return [Array<(DIDPoolEntityListing, Fixnum, Hash)>] DIDPoolEntityListing data, response status code and response headers
|
3017
3019
|
def get_telephony_providers_edges_didpools_with_http_info(opts = {})
|
3018
3020
|
if @api_client.config.debugging
|
@@ -3032,6 +3034,12 @@ module PureCloud
|
|
3032
3034
|
|
3033
3035
|
|
3034
3036
|
|
3037
|
+
|
3038
|
+
|
3039
|
+
|
3040
|
+
|
3041
|
+
|
3042
|
+
|
3035
3043
|
|
3036
3044
|
|
3037
3045
|
|
@@ -3045,6 +3053,7 @@ module PureCloud
|
|
3045
3053
|
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
|
3046
3054
|
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
|
3047
3055
|
query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
|
3056
|
+
query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
|
3048
3057
|
|
3049
3058
|
# header parameters
|
3050
3059
|
header_params = {}
|
@@ -3087,6 +3096,7 @@ module PureCloud
|
|
3087
3096
|
# @option opts [String] :phone_number Filter by phoneNumber
|
3088
3097
|
# @option opts [String] :owner_id Filter by the owner of a phone number
|
3089
3098
|
# @option opts [String] :did_pool_id Filter by the DID Pool assignment
|
3099
|
+
# @option opts [Array<String>] :id Filter by a specific list of ID's
|
3090
3100
|
# @return [DIDEntityListing]
|
3091
3101
|
def get_telephony_providers_edges_dids(opts = {})
|
3092
3102
|
data, _status_code, _headers = get_telephony_providers_edges_dids_with_http_info(opts)
|
@@ -3103,6 +3113,7 @@ module PureCloud
|
|
3103
3113
|
# @option opts [String] :phone_number Filter by phoneNumber
|
3104
3114
|
# @option opts [String] :owner_id Filter by the owner of a phone number
|
3105
3115
|
# @option opts [String] :did_pool_id Filter by the DID Pool assignment
|
3116
|
+
# @option opts [Array<String>] :id Filter by a specific list of ID's
|
3106
3117
|
# @return [Array<(DIDEntityListing, Fixnum, Hash)>] DIDEntityListing data, response status code and response headers
|
3107
3118
|
def get_telephony_providers_edges_dids_with_http_info(opts = {})
|
3108
3119
|
if @api_client.config.debugging
|
@@ -3144,6 +3155,12 @@ module PureCloud
|
|
3144
3155
|
|
3145
3156
|
|
3146
3157
|
|
3158
|
+
|
3159
|
+
|
3160
|
+
|
3161
|
+
|
3162
|
+
|
3163
|
+
|
3147
3164
|
|
3148
3165
|
|
3149
3166
|
|
@@ -3163,6 +3180,7 @@ module PureCloud
|
|
3163
3180
|
query_params[:'phoneNumber'] = opts[:'phone_number'] if opts[:'phone_number']
|
3164
3181
|
query_params[:'owner.id'] = opts[:'owner_id'] if opts[:'owner_id']
|
3165
3182
|
query_params[:'didPool.id'] = opts[:'did_pool_id'] if opts[:'did_pool_id']
|
3183
|
+
query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
|
3166
3184
|
|
3167
3185
|
# header parameters
|
3168
3186
|
header_params = {}
|
@@ -0,0 +1,92 @@
|
|
1
|
+
=begin
|
2
|
+
PureCloud Platform API
|
3
|
+
|
4
|
+
With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
|
5
|
+
|
6
|
+
OpenAPI spec version: v2
|
7
|
+
Contact: DeveloperEvangelists@genesys.com
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
|
10
|
+
License: UNLICENSED
|
11
|
+
https://help.mypurecloud.com/articles/terms-and-conditions/
|
12
|
+
|
13
|
+
Terms of Service: https://help.mypurecloud.com/articles/terms-and-conditions/
|
14
|
+
|
15
|
+
=end
|
16
|
+
|
17
|
+
require "uri"
|
18
|
+
|
19
|
+
module PureCloud
|
20
|
+
class TextbotsApi
|
21
|
+
attr_accessor :api_client
|
22
|
+
|
23
|
+
def initialize(api_client = ApiClient.default)
|
24
|
+
@api_client = api_client
|
25
|
+
end
|
26
|
+
|
27
|
+
# Send an intent to a bot to start a dialog/interact with it via text
|
28
|
+
# This will either start a bot with the given id or relay a communication to an existing bot session.
|
29
|
+
# @param post_text_request
|
30
|
+
# @param [Hash] opts the optional parameters
|
31
|
+
# @return [PostTextResponse]
|
32
|
+
def post_textbots_bots_execute(post_text_request, opts = {})
|
33
|
+
data, _status_code, _headers = post_textbots_bots_execute_with_http_info(post_text_request, opts)
|
34
|
+
return data
|
35
|
+
end
|
36
|
+
|
37
|
+
# Send an intent to a bot to start a dialog/interact with it via text
|
38
|
+
# This will either start a bot with the given id or relay a communication to an existing bot session.
|
39
|
+
# @param post_text_request
|
40
|
+
# @param [Hash] opts the optional parameters
|
41
|
+
# @return [Array<(PostTextResponse, Fixnum, Hash)>] PostTextResponse data, response status code and response headers
|
42
|
+
def post_textbots_bots_execute_with_http_info(post_text_request, opts = {})
|
43
|
+
if @api_client.config.debugging
|
44
|
+
@api_client.config.logger.debug "Calling API: TextbotsApi.post_textbots_bots_execute ..."
|
45
|
+
end
|
46
|
+
|
47
|
+
|
48
|
+
# verify the required parameter 'post_text_request' is set
|
49
|
+
fail ArgumentError, "Missing the required parameter 'post_text_request' when calling TextbotsApi.post_textbots_bots_execute" if post_text_request.nil?
|
50
|
+
|
51
|
+
|
52
|
+
|
53
|
+
|
54
|
+
|
55
|
+
# resource path
|
56
|
+
local_var_path = "/api/v2/textbots/bots/execute".sub('{format}','json')
|
57
|
+
|
58
|
+
# query parameters
|
59
|
+
query_params = {}
|
60
|
+
|
61
|
+
# header parameters
|
62
|
+
header_params = {}
|
63
|
+
|
64
|
+
# HTTP header 'Accept' (if needed)
|
65
|
+
local_header_accept = ['application/json']
|
66
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
67
|
+
|
68
|
+
# HTTP header 'Content-Type'
|
69
|
+
local_header_content_type = ['application/json']
|
70
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
71
|
+
|
72
|
+
# form parameters
|
73
|
+
form_params = {}
|
74
|
+
|
75
|
+
# http body (model)
|
76
|
+
post_body = @api_client.object_to_http_body(post_text_request)
|
77
|
+
|
78
|
+
auth_names = ['PureCloud OAuth']
|
79
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
80
|
+
:header_params => header_params,
|
81
|
+
:query_params => query_params,
|
82
|
+
:form_params => form_params,
|
83
|
+
:body => post_body,
|
84
|
+
:auth_names => auth_names,
|
85
|
+
:return_type => 'PostTextResponse')
|
86
|
+
if @api_client.config.debugging
|
87
|
+
@api_client.config.logger.debug "API called: TextbotsApi#post_textbots_bots_execute\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
88
|
+
end
|
89
|
+
return data, status_code, headers
|
90
|
+
end
|
91
|
+
end
|
92
|
+
end
|
@@ -1178,6 +1178,7 @@ module PureCloud
|
|
1178
1178
|
# @option opts [Array<String>] :jid jid
|
1179
1179
|
# @option opts [String] :sort_order Ascending or descending sort order (default to ASC)
|
1180
1180
|
# @option opts [Array<String>] :expand Which fields, if any, to expand
|
1181
|
+
# @option opts [String] :integration_presence_source Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \"expand\".
|
1181
1182
|
# @return [UserProfileEntityListing]
|
1182
1183
|
def get_profiles_users(opts = {})
|
1183
1184
|
data, _status_code, _headers = get_profiles_users_with_http_info(opts)
|
@@ -1193,6 +1194,7 @@ module PureCloud
|
|
1193
1194
|
# @option opts [Array<String>] :jid jid
|
1194
1195
|
# @option opts [String] :sort_order Ascending or descending sort order
|
1195
1196
|
# @option opts [Array<String>] :expand Which fields, if any, to expand
|
1197
|
+
# @option opts [String] :integration_presence_source Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \"expand\".
|
1196
1198
|
# @return [Array<(UserProfileEntityListing, Fixnum, Hash)>] UserProfileEntityListing data, response status code and response headers
|
1197
1199
|
def get_profiles_users_with_http_info(opts = {})
|
1198
1200
|
if @api_client.config.debugging
|
@@ -1239,6 +1241,16 @@ module PureCloud
|
|
1239
1241
|
|
1240
1242
|
|
1241
1243
|
|
1244
|
+
|
1245
|
+
|
1246
|
+
|
1247
|
+
if opts[:'integration_presence_source'] && !['MicrosoftTeams', 'ZoomPhone'].include?(opts[:'integration_presence_source'])
|
1248
|
+
fail ArgumentError, 'invalid value for "integration_presence_source", must be one of MicrosoftTeams, ZoomPhone'
|
1249
|
+
end
|
1250
|
+
|
1251
|
+
|
1252
|
+
|
1253
|
+
|
1242
1254
|
# resource path
|
1243
1255
|
local_var_path = "/api/v2/profiles/users".sub('{format}','json')
|
1244
1256
|
|
@@ -1250,6 +1262,7 @@ module PureCloud
|
|
1250
1262
|
query_params[:'jid'] = @api_client.build_collection_param(opts[:'jid'], :multi) if opts[:'jid']
|
1251
1263
|
query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
|
1252
1264
|
query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
|
1265
|
+
query_params[:'integrationPresenceSource'] = opts[:'integration_presence_source'] if opts[:'integration_presence_source']
|
1253
1266
|
|
1254
1267
|
# header parameters
|
1255
1268
|
header_params = {}
|
@@ -1352,6 +1365,7 @@ module PureCloud
|
|
1352
1365
|
# @param user_id User ID
|
1353
1366
|
# @param [Hash] opts the optional parameters
|
1354
1367
|
# @option opts [Array<String>] :expand Which fields, if any, to expand
|
1368
|
+
# @option opts [String] :integration_presence_source Gets an integration presence for a user instead of their default.
|
1355
1369
|
# @option opts [String] :state Search for a user with this state (default to active)
|
1356
1370
|
# @return [User]
|
1357
1371
|
def get_user(user_id, opts = {})
|
@@ -1364,6 +1378,7 @@ module PureCloud
|
|
1364
1378
|
# @param user_id User ID
|
1365
1379
|
# @param [Hash] opts the optional parameters
|
1366
1380
|
# @option opts [Array<String>] :expand Which fields, if any, to expand
|
1381
|
+
# @option opts [String] :integration_presence_source Gets an integration presence for a user instead of their default.
|
1367
1382
|
# @option opts [String] :state Search for a user with this state
|
1368
1383
|
# @return [Array<(User, Fixnum, Hash)>] User data, response status code and response headers
|
1369
1384
|
def get_user_with_http_info(user_id, opts = {})
|
@@ -1388,6 +1403,16 @@ module PureCloud
|
|
1388
1403
|
|
1389
1404
|
|
1390
1405
|
|
1406
|
+
if opts[:'integration_presence_source'] && !['MicrosoftTeams', 'ZoomPhone'].include?(opts[:'integration_presence_source'])
|
1407
|
+
fail ArgumentError, 'invalid value for "integration_presence_source", must be one of MicrosoftTeams, ZoomPhone'
|
1408
|
+
end
|
1409
|
+
|
1410
|
+
|
1411
|
+
|
1412
|
+
|
1413
|
+
|
1414
|
+
|
1415
|
+
|
1391
1416
|
if opts[:'state'] && !['active', 'deleted'].include?(opts[:'state'])
|
1392
1417
|
fail ArgumentError, 'invalid value for "state", must be one of active, deleted'
|
1393
1418
|
end
|
@@ -1401,6 +1426,7 @@ module PureCloud
|
|
1401
1426
|
# query parameters
|
1402
1427
|
query_params = {}
|
1403
1428
|
query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
|
1429
|
+
query_params[:'integrationPresenceSource'] = opts[:'integration_presence_source'] if opts[:'integration_presence_source']
|
1404
1430
|
query_params[:'state'] = opts[:'state'] if opts[:'state']
|
1405
1431
|
|
1406
1432
|
# header parameters
|
@@ -1893,6 +1919,7 @@ module PureCloud
|
|
1893
1919
|
# @param user_id userId
|
1894
1920
|
# @param [Hash] opts the optional parameters
|
1895
1921
|
# @option opts [Array<String>] :expand Which fields, if any, to expand
|
1922
|
+
# @option opts [String] :integration_presence_source Gets an integration presence for a user instead of their default.
|
1896
1923
|
# @return [UserProfile]
|
1897
1924
|
def get_user_profile(user_id, opts = {})
|
1898
1925
|
data, _status_code, _headers = get_user_profile_with_http_info(user_id, opts)
|
@@ -1904,6 +1931,7 @@ module PureCloud
|
|
1904
1931
|
# @param user_id userId
|
1905
1932
|
# @param [Hash] opts the optional parameters
|
1906
1933
|
# @option opts [Array<String>] :expand Which fields, if any, to expand
|
1934
|
+
# @option opts [String] :integration_presence_source Gets an integration presence for a user instead of their default.
|
1907
1935
|
# @return [Array<(UserProfile, Fixnum, Hash)>] UserProfile data, response status code and response headers
|
1908
1936
|
def get_user_profile_with_http_info(user_id, opts = {})
|
1909
1937
|
if @api_client.config.debugging
|
@@ -1924,12 +1952,23 @@ module PureCloud
|
|
1924
1952
|
|
1925
1953
|
|
1926
1954
|
|
1955
|
+
|
1956
|
+
|
1957
|
+
|
1958
|
+
if opts[:'integration_presence_source'] && !['MicrosoftTeams', 'ZoomPhone'].include?(opts[:'integration_presence_source'])
|
1959
|
+
fail ArgumentError, 'invalid value for "integration_presence_source", must be one of MicrosoftTeams, ZoomPhone'
|
1960
|
+
end
|
1961
|
+
|
1962
|
+
|
1963
|
+
|
1964
|
+
|
1927
1965
|
# resource path
|
1928
1966
|
local_var_path = "/api/v2/users/{userId}/profile".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
|
1929
1967
|
|
1930
1968
|
# query parameters
|
1931
1969
|
query_params = {}
|
1932
1970
|
query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
|
1971
|
+
query_params[:'integrationPresenceSource'] = opts[:'integration_presence_source'] if opts[:'integration_presence_source']
|
1933
1972
|
|
1934
1973
|
# header parameters
|
1935
1974
|
header_params = {}
|
@@ -2681,6 +2720,7 @@ module PureCloud
|
|
2681
2720
|
# @option opts [Array<String>] :jabber_id A list of jabberIds to fetch by bulk (cannot be used with the \"id\" parameter)
|
2682
2721
|
# @option opts [String] :sort_order Ascending or descending sort order (default to ASC)
|
2683
2722
|
# @option opts [Array<String>] :expand Which fields, if any, to expand
|
2723
|
+
# @option opts [String] :integration_presence_source Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \"expand\". When using this parameter the maximum number of users that can be returned is 10.
|
2684
2724
|
# @option opts [String] :state Only list users of this state (default to active)
|
2685
2725
|
# @return [UserEntityListing]
|
2686
2726
|
def get_users(opts = {})
|
@@ -2697,6 +2737,7 @@ module PureCloud
|
|
2697
2737
|
# @option opts [Array<String>] :jabber_id A list of jabberIds to fetch by bulk (cannot be used with the \"id\" parameter)
|
2698
2738
|
# @option opts [String] :sort_order Ascending or descending sort order
|
2699
2739
|
# @option opts [Array<String>] :expand Which fields, if any, to expand
|
2740
|
+
# @option opts [String] :integration_presence_source Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \"expand\". When using this parameter the maximum number of users that can be returned is 10.
|
2700
2741
|
# @option opts [String] :state Only list users of this state
|
2701
2742
|
# @return [Array<(UserEntityListing, Fixnum, Hash)>] UserEntityListing data, response status code and response headers
|
2702
2743
|
def get_users_with_http_info(opts = {})
|
@@ -2747,6 +2788,16 @@ module PureCloud
|
|
2747
2788
|
|
2748
2789
|
|
2749
2790
|
|
2791
|
+
if opts[:'integration_presence_source'] && !['MicrosoftTeams', 'ZoomPhone'].include?(opts[:'integration_presence_source'])
|
2792
|
+
fail ArgumentError, 'invalid value for "integration_presence_source", must be one of MicrosoftTeams, ZoomPhone'
|
2793
|
+
end
|
2794
|
+
|
2795
|
+
|
2796
|
+
|
2797
|
+
|
2798
|
+
|
2799
|
+
|
2800
|
+
|
2750
2801
|
if opts[:'state'] && !['active', 'inactive', 'deleted', 'any'].include?(opts[:'state'])
|
2751
2802
|
fail ArgumentError, 'invalid value for "state", must be one of active, inactive, deleted, any'
|
2752
2803
|
end
|
@@ -2765,6 +2816,7 @@ module PureCloud
|
|
2765
2816
|
query_params[:'jabberId'] = @api_client.build_collection_param(opts[:'jabber_id'], :multi) if opts[:'jabber_id']
|
2766
2817
|
query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
|
2767
2818
|
query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
|
2819
|
+
query_params[:'integrationPresenceSource'] = opts[:'integration_presence_source'] if opts[:'integration_presence_source']
|
2768
2820
|
query_params[:'state'] = opts[:'state'] if opts[:'state']
|
2769
2821
|
|
2770
2822
|
# header parameters
|
@@ -2802,6 +2854,7 @@ module PureCloud
|
|
2802
2854
|
# This request is not valid when using the Client Credentials OAuth grant.
|
2803
2855
|
# @param [Hash] opts the optional parameters
|
2804
2856
|
# @option opts [Array<String>] :expand Which fields, if any, to expand.
|
2857
|
+
# @option opts [String] :integration_presence_source Get your presence for a given integration. This parameter will only be used when presence is provided as an \"expand\".
|
2805
2858
|
# @return [UserMe]
|
2806
2859
|
def get_users_me(opts = {})
|
2807
2860
|
data, _status_code, _headers = get_users_me_with_http_info(opts)
|
@@ -2812,6 +2865,7 @@ module PureCloud
|
|
2812
2865
|
# This request is not valid when using the Client Credentials OAuth grant.
|
2813
2866
|
# @param [Hash] opts the optional parameters
|
2814
2867
|
# @option opts [Array<String>] :expand Which fields, if any, to expand.
|
2868
|
+
# @option opts [String] :integration_presence_source Get your presence for a given integration. This parameter will only be used when presence is provided as an \"expand\".
|
2815
2869
|
# @return [Array<(UserMe, Fixnum, Hash)>] UserMe data, response status code and response headers
|
2816
2870
|
def get_users_me_with_http_info(opts = {})
|
2817
2871
|
if @api_client.config.debugging
|
@@ -2824,12 +2878,23 @@ module PureCloud
|
|
2824
2878
|
|
2825
2879
|
|
2826
2880
|
|
2881
|
+
|
2882
|
+
|
2883
|
+
|
2884
|
+
if opts[:'integration_presence_source'] && !['MicrosoftTeams', 'ZoomPhone'].include?(opts[:'integration_presence_source'])
|
2885
|
+
fail ArgumentError, 'invalid value for "integration_presence_source", must be one of MicrosoftTeams, ZoomPhone'
|
2886
|
+
end
|
2887
|
+
|
2888
|
+
|
2889
|
+
|
2890
|
+
|
2827
2891
|
# resource path
|
2828
2892
|
local_var_path = "/api/v2/users/me".sub('{format}','json')
|
2829
2893
|
|
2830
2894
|
# query parameters
|
2831
2895
|
query_params = {}
|
2832
2896
|
query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
|
2897
|
+
query_params[:'integrationPresenceSource'] = opts[:'integration_presence_source'] if opts[:'integration_presence_source']
|
2833
2898
|
|
2834
2899
|
# header parameters
|
2835
2900
|
header_params = {}
|
@@ -2867,6 +2932,7 @@ module PureCloud
|
|
2867
2932
|
# @param q64 q64
|
2868
2933
|
# @param [Hash] opts the optional parameters
|
2869
2934
|
# @option opts [Array<String>] :expand expand
|
2935
|
+
# @option opts [String] :integration_presence_source integrationPresenceSource
|
2870
2936
|
# @return [UsersSearchResponse]
|
2871
2937
|
def get_users_search(q64, opts = {})
|
2872
2938
|
data, _status_code, _headers = get_users_search_with_http_info(q64, opts)
|
@@ -2878,6 +2944,7 @@ module PureCloud
|
|
2878
2944
|
# @param q64 q64
|
2879
2945
|
# @param [Hash] opts the optional parameters
|
2880
2946
|
# @option opts [Array<String>] :expand expand
|
2947
|
+
# @option opts [String] :integration_presence_source integrationPresenceSource
|
2881
2948
|
# @return [Array<(UsersSearchResponse, Fixnum, Hash)>] UsersSearchResponse data, response status code and response headers
|
2882
2949
|
def get_users_search_with_http_info(q64, opts = {})
|
2883
2950
|
if @api_client.config.debugging
|
@@ -2898,6 +2965,16 @@ module PureCloud
|
|
2898
2965
|
|
2899
2966
|
|
2900
2967
|
|
2968
|
+
|
2969
|
+
|
2970
|
+
|
2971
|
+
if opts[:'integration_presence_source'] && !['MicrosoftTeams', 'ZoomPhone'].include?(opts[:'integration_presence_source'])
|
2972
|
+
fail ArgumentError, 'invalid value for "integration_presence_source", must be one of MicrosoftTeams, ZoomPhone'
|
2973
|
+
end
|
2974
|
+
|
2975
|
+
|
2976
|
+
|
2977
|
+
|
2901
2978
|
# resource path
|
2902
2979
|
local_var_path = "/api/v2/users/search".sub('{format}','json')
|
2903
2980
|
|
@@ -2905,6 +2982,7 @@ module PureCloud
|
|
2905
2982
|
query_params = {}
|
2906
2983
|
query_params[:'q64'] = q64
|
2907
2984
|
query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
|
2985
|
+
query_params[:'integrationPresenceSource'] = opts[:'integration_presence_source'] if opts[:'integration_presence_source']
|
2908
2986
|
|
2909
2987
|
# header parameters
|
2910
2988
|
header_params = {}
|