purecloudplatformclientv2 93.0.0 → 94.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/ActionEntityListing.md +1 -1
- data/docs/AfterCallWork.md +15 -0
- data/docs/AgentActivityEntityListing.md +1 -1
- data/docs/AnalyticsApi.md +67 -1
- data/docs/AnalyticsEvaluation.md +1 -1
- data/docs/AnalyticsParticipant.md +1 -0
- data/docs/AnalyticsParticipantWithoutAttributes.md +1 -0
- data/docs/AttemptLimitsEntityListing.md +1 -1
- data/docs/AuthorizationApi.md +12 -12
- data/docs/AuthzDivisionEntityListing.md +1 -1
- data/docs/Biography.md +1 -0
- data/docs/CalibrationEntityListing.md +1 -1
- data/docs/Call.md +1 -0
- data/docs/CallBasic.md +1 -0
- data/docs/CallConversationEntityListing.md +1 -1
- data/docs/CallHistoryConversationEntityListing.md +1 -1
- data/docs/CallableTimeSetEntityListing.md +1 -1
- data/docs/Callback.md +1 -0
- data/docs/CallbackBasic.md +1 -0
- data/docs/CallbackConversationEntityListing.md +1 -1
- data/docs/CampaignDivisionViewListing.md +1 -1
- data/docs/CampaignEntityListing.md +1 -1
- data/docs/CampaignRuleEntityListing.md +1 -1
- data/docs/CampaignSequenceEntityListing.md +1 -1
- data/docs/CertificateAuthorityEntityListing.md +1 -1
- data/docs/CertificateDetails.md +1 -1
- data/docs/ChatConversationEntityListing.md +1 -1
- data/docs/ClientAppEntityListing.md +1 -1
- data/docs/CoachingAnnotationList.md +1 -1
- data/docs/CoachingApi.md +18 -18
- data/docs/CoachingAppointmentResponseList.md +1 -1
- data/docs/CoachingNotificationList.md +1 -1
- data/docs/CobrowseConversationEntityListing.md +1 -1
- data/docs/Cobrowsesession.md +1 -0
- data/docs/CommandStatusEntityListing.md +1 -1
- data/docs/CommonCampaignDivisionViewEntityListing.md +1 -1
- data/docs/CommonCampaignEntityListing.md +1 -1
- data/docs/ConsumedResourcesEntityListing.md +1 -1
- data/docs/ConsumingResourcesEntityListing.md +1 -1
- data/docs/Contact.md +1 -0
- data/docs/ContactListDivisionViewListing.md +1 -1
- data/docs/ContactListEntityListing.md +1 -1
- data/docs/ContactListFilterEntityListing.md +1 -1
- data/docs/ContactListing.md +1 -1
- data/docs/ConversationChat.md +1 -0
- data/docs/ConversationEntityListing.md +1 -1
- 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 +1 -0
- data/docs/ConversationEventTopicScreenshare.md +1 -0
- data/docs/ConversationEventTopicSocialExpression.md +1 -0
- data/docs/ConversationEventTopicVideo.md +1 -0
- data/docs/ConversationsApi.md +69 -0
- data/docs/CredentialInfoListing.md +1 -1
- data/docs/CredentialTypeListing.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/DIDEntityListing.md +1 -1
- data/docs/DIDPoolEntityListing.md +1 -1
- data/docs/DataTableRowEntityListing.md +1 -1
- data/docs/DataTablesDomainEntityListing.md +1 -1
- data/docs/DependencyObjectEntityListing.md +1 -1
- data/docs/DependencyTypeEntityListing.md +1 -1
- data/docs/DialerEventEntityListing.md +1 -1
- data/docs/DialogflowAgentSummaryEntityListing.md +1 -1
- data/docs/DirectoryUserDevicesListing.md +1 -1
- data/docs/DivsPermittedEntityListing.md +1 -1
- data/docs/DncListDivisionViewListing.md +1 -1
- data/docs/DncListEntityListing.md +1 -1
- data/docs/DocumentAuditEntityListing.md +1 -1
- data/docs/DocumentEntityListing.md +1 -1
- data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +1 -1
- data/docs/DomainEntityListing.md +1 -1
- data/docs/DomainEntityListingEvaluationForm.md +1 -1
- data/docs/DomainEntityListingQueryResult.md +1 -1
- data/docs/DomainEntityListingSurveyForm.md +1 -1
- data/docs/EdgeEntityListing.md +1 -1
- data/docs/EdgeGroupEntityListing.md +1 -1
- data/docs/EdgeLineEntityListing.md +1 -1
- data/docs/Education.md +17 -0
- data/docs/Email.md +1 -0
- data/docs/EmailConversationEntityListing.md +1 -1
- data/docs/EmailMessageListing.md +1 -1
- data/docs/EmergencyGroupListing.md +1 -1
- data/docs/EncryptionKeyEntityListing.md +1 -1
- data/docs/EvaluationEntityListing.md +1 -1
- data/docs/EvaluationFormEntityListing.md +1 -1
- data/docs/EvaluatorActivityEntityListing.md +1 -1
- data/docs/ExtensionEntityListing.md +1 -1
- data/docs/ExtensionPoolEntityListing.md +1 -1
- data/docs/ExternalContactsApi.md +281 -5
- data/docs/ExternalOrganizationListing.md +1 -1
- data/docs/FacebookIntegrationEntityListing.md +1 -1
- data/docs/FacebookIntegrationUpdateRequest.md +14 -0
- data/docs/FaxDocumentEntityListing.md +1 -1
- data/docs/FlowDivisionViewEntityListing.md +1 -1
- data/docs/FlowEntityListing.md +1 -1
- data/docs/FlowOutcomeListing.md +1 -1
- data/docs/FlowVersionEntityListing.md +1 -1
- data/docs/GDPRRequestEntityListing.md +1 -1
- data/docs/GDPRSubjectEntityListing.md +1 -1
- data/docs/GreetingListing.md +1 -1
- data/docs/GroupEntityListing.md +1 -1
- data/docs/GroupProfileEntityListing.md +1 -1
- data/docs/HistoryListing.md +1 -1
- data/docs/IVREntityListing.md +1 -1
- data/docs/InboundDomainEntityListing.md +1 -1
- data/docs/InboundRouteEntityListing.md +1 -1
- data/docs/IntegrationEntityListing.md +1 -1
- data/docs/IntegrationEventEntityListing.md +1 -1
- data/docs/IntegrationTypeEntityListing.md +1 -1
- data/docs/IntegrationsApi.md +14 -14
- data/docs/InteractionStatsAlertContainer.md +1 -1
- data/docs/InteractionStatsRuleContainer.md +1 -1
- 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/KeywordSetEntityListing.md +1 -1
- data/docs/LanguageEntityListing.md +1 -1
- data/docs/LexBotAliasEntityListing.md +1 -1
- data/docs/LexBotEntityListing.md +1 -1
- data/docs/LibraryEntityListing.md +1 -1
- data/docs/LineBaseEntityListing.md +1 -1
- data/docs/LineEntityListing.md +1 -1
- data/docs/LineIntegrationEntityListing.md +1 -1
- data/docs/LocationEntityListing.md +1 -1
- data/docs/LogicalInterfaceEntityListing.md +1 -1
- data/docs/ManagementUnitListing.md +1 -1
- data/docs/Message.md +1 -0
- data/docs/MessageConversationEntityListing.md +1 -1
- data/docs/MessagingCampaignDivisionViewEntityListing.md +1 -1
- data/docs/MessagingCampaignEntityListing.md +1 -1
- data/docs/MessagingIntegrationEntityListing.md +1 -1
- data/docs/MessagingStickerEntityListing.md +1 -1
- data/docs/NluDomainListing.md +1 -1
- data/docs/NluDomainVersionListing.md +1 -1
- data/docs/NluFeedbackListing.md +1 -1
- data/docs/NoteListing.md +1 -1
- data/docs/OAuthClient.md +1 -0
- data/docs/OAuthClientEntityListing.md +1 -1
- data/docs/OAuthClientListing.md +1 -0
- data/docs/OAuthClientRequest.md +1 -0
- data/docs/OAuthProviderEntityListing.md +1 -1
- data/docs/ObjectsApi.md +4 -4
- data/docs/OrgOAuthClient.md +1 -0
- data/docs/OrganizationPresenceEntityListing.md +1 -1
- data/docs/OrganizationRoleEntityListing.md +1 -1
- data/docs/OrphanRecordingListing.md +1 -1
- data/docs/OutboundRouteBaseEntityListing.md +1 -1
- data/docs/OutboundRouteEntityListing.md +1 -1
- data/docs/PermissionCollectionEntityListing.md +1 -1
- data/docs/PhoneBaseEntityListing.md +1 -1
- data/docs/PhoneCapabilities.md +1 -0
- data/docs/PhoneEntityListing.md +1 -1
- data/docs/PhoneMetaBaseEntityListing.md +1 -1
- data/docs/PhysicalInterfaceEntityListing.md +1 -1
- data/docs/PolicyEntityListing.md +1 -1
- data/docs/PresenceApi.md +206 -6
- data/docs/PresenceExpand.md +17 -0
- data/docs/PromptAssetEntityListing.md +1 -1
- data/docs/PromptEntityListing.md +1 -1
- data/docs/QualityApi.md +18 -18
- data/docs/QualityAuditPage.md +1 -1
- 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 +1 -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 +1 -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 +1 -0
- data/docs/QueueConversationVideoEventTopicScreenshare.md +1 -0
- data/docs/QueueConversationVideoEventTopicSocialExpression.md +1 -0
- data/docs/QueueConversationVideoEventTopicVideo.md +1 -0
- data/docs/QueueEntityListing.md +1 -1
- data/docs/QueueMemberEntityListing.md +1 -1
- data/docs/RecipientListing.md +1 -1
- data/docs/RecordingApi.md +4 -4
- data/docs/RecordingJobEntityListing.md +1 -1
- data/docs/RelationshipListing.md +1 -1
- data/docs/ReportMetaDataEntityListing.md +1 -1
- data/docs/ReportRunEntryEntityDomainListing.md +1 -1
- data/docs/ReportScheduleEntityListing.md +1 -1
- data/docs/ReportingExportJobListing.md +1 -1
- data/docs/ReportingExportMetadataJobListing.md +1 -1
- data/docs/ResponseEntityList.md +1 -1
- data/docs/ResponseEntityListing.md +1 -1
- data/docs/ResponseSetEntityListing.md +1 -1
- data/docs/RuleSetEntityListing.md +1 -1
- data/docs/SCIMApi.md +108 -108
- data/docs/ScheduleEntityListing.md +1 -1
- data/docs/ScheduleGroupEntityListing.md +1 -1
- data/docs/SchemaCategoryEntityListing.md +1 -1
- data/docs/SchemaReferenceEntityListing.md +1 -1
- data/docs/ScimConfigResourceType.md +0 -1
- data/docs/ScimGenesysUserExternalId.md +14 -0
- data/docs/ScimServiceProviderConfig.md +0 -1
- data/docs/ScimUserExtensions.md +1 -0
- data/docs/ScimV2Group.md +0 -1
- data/docs/ScimV2SchemaDefinition.md +0 -1
- data/docs/ScimV2User.md +0 -1
- data/docs/ScreenRecordingSessionListing.md +1 -1
- data/docs/Screenshare.md +1 -0
- data/docs/ScriptEntityListing.md +1 -1
- data/docs/SearchApi.md +3 -1
- data/docs/SecurityProfileEntityListing.md +1 -1
- data/docs/ShareEntityListing.md +1 -1
- data/docs/SiteEntityListing.md +1 -1
- data/docs/SkillEntityListing.md +1 -1
- data/docs/SmsAddressEntityListing.md +1 -1
- data/docs/SmsPhoneNumberEntityListing.md +1 -1
- data/docs/SocialExpression.md +1 -0
- data/docs/StationEntityListing.md +1 -1
- data/docs/SubjectDivisionGrantsEntityListing.md +1 -1
- data/docs/SurveyFormEntityListing.md +1 -1
- data/docs/SystemPromptAssetEntityListing.md +1 -1
- data/docs/SystemPromptEntityListing.md +1 -1
- data/docs/TagValueEntityListing.md +1 -1
- data/docs/TelephonyProvidersEdgeApi.md +6 -2
- data/docs/TextMessageListing.md +1 -1
- data/docs/TimeZoneEntityListing.md +1 -1
- data/docs/TrunkBaseEntityListing.md +1 -1
- data/docs/TrunkEntityListing.md +1 -1
- data/docs/TrunkMetabaseEntityListing.md +1 -1
- data/docs/TrustEntityListing.md +1 -1
- data/docs/TrustUserEntityListing.md +1 -1
- data/docs/TrustorEntityListing.md +1 -1
- data/docs/TtsEngineEntityListing.md +1 -1
- data/docs/TtsVoiceEntityListing.md +1 -1
- data/docs/TwitterIntegrationEntityListing.md +1 -1
- data/docs/UpdateCoachingAppointmentRequest.md +1 -0
- data/docs/UserActionCategoryEntityListing.md +1 -1
- data/docs/UserAppEntityListing.md +1 -1
- data/docs/UserEntityListing.md +1 -1
- data/docs/UserLanguageEntityListing.md +1 -1
- data/docs/UserProfileEntityListing.md +1 -1
- data/docs/UserQueueEntityListing.md +1 -1
- data/docs/UserRecordingEntityListing.md +1 -1
- data/docs/UserSearchRequest.md +1 -0
- data/docs/UserSkillEntityListing.md +1 -1
- data/docs/UsersApi.md +16 -4
- data/docs/Video.md +1 -0
- data/docs/VoicemailMessageEntityListing.md +1 -1
- data/docs/WebChatMemberInfoEntityList.md +1 -1
- data/docs/WfmHistoricalDataUploadPurgeRequestStatusTopicHistoricalDataUploadPurgeRequestUpdate.md +13 -0
- data/docs/WhatsAppIntegrationEntityListing.md +1 -1
- data/docs/WorkspaceEntityListing.md +1 -1
- data/docs/WorkspaceMemberEntityListing.md +1 -1
- data/docs/WrapupCodeEntityListing.md +1 -1
- data/lib/purecloudplatformclientv2.rb +22 -1
- data/lib/purecloudplatformclientv2/api/analytics_api.rb +67 -2
- data/lib/purecloudplatformclientv2/api/authorization_api.rb +12 -12
- data/lib/purecloudplatformclientv2/api/conversations_api.rb +75 -0
- data/lib/purecloudplatformclientv2/api/external_contacts_api.rb +301 -9
- data/lib/purecloudplatformclientv2/api/integrations_api.rb +14 -14
- data/lib/purecloudplatformclientv2/api/journey_api.rb +92 -0
- data/lib/purecloudplatformclientv2/api/objects_api.rb +4 -4
- data/lib/purecloudplatformclientv2/api/presence_api.rb +213 -8
- data/lib/purecloudplatformclientv2/api/quality_api.rb +18 -18
- data/lib/purecloudplatformclientv2/api/recording_api.rb +4 -4
- data/lib/purecloudplatformclientv2/api/scim_api.rb +110 -110
- data/lib/purecloudplatformclientv2/api/search_api.rb +13 -0
- data/lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb +18 -0
- data/lib/purecloudplatformclientv2/api/users_api.rb +78 -0
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/after_call_work.rb +267 -0
- data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/analytics_evaluation.rb +13 -13
- data/lib/purecloudplatformclientv2/models/analytics_participant.rb +29 -1
- data/lib/purecloudplatformclientv2/models/analytics_participant_without_attributes.rb +29 -1
- data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/authz_division_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/biography.rb +32 -4
- data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/call.rb +30 -4
- data/lib/purecloudplatformclientv2/models/call_basic.rb +30 -4
- data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/callback.rb +30 -4
- data/lib/purecloudplatformclientv2/models/callback_basic.rb +30 -4
- data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/certificate_details.rb +13 -13
- data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/coaching_annotation_list.rb +12 -12
- data/lib/purecloudplatformclientv2/models/coaching_appointment_response_list.rb +12 -12
- data/lib/purecloudplatformclientv2/models/coaching_notification_list.rb +12 -12
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/cobrowsesession.rb +30 -4
- data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/common_campaign_division_view_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/common_campaign_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact.rb +29 -4
- data/lib/purecloudplatformclientv2/models/contact_list_division_view_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/conversation_aggregate_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/conversation_chat.rb +30 -4
- data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +12 -12
- 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 +26 -1
- 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/credential_info_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +12 -12
- 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/data_table_row_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dialogflow_agent_summary_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/divs_permitted_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dnc_list_division_view_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/education.rb +304 -0
- data/lib/purecloudplatformclientv2/models/email.rb +30 -4
- data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/email_message_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/facebook_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/facebook_integration_update_request.rb +228 -0
- data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_aggregate_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_outcome_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/greeting_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/history_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +12 -12
- data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +12 -12
- data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +12 -12
- 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/{scim_metadata.rb → journey_aggregate_query_filter.rb} +39 -57
- 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/keyword_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/lex_bot_alias_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/lex_bot_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/library.rb +2 -2
- data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/line_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/message.rb +30 -4
- data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/messaging_campaign_division_view_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/messaging_campaign_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/messaging_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/messaging_sticker_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/nlu_domain_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/nlu_domain_version_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/nlu_feedback_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/note_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/o_auth_client.rb +41 -1
- data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/o_auth_client_listing.rb +41 -1
- data/lib/purecloudplatformclientv2/models/o_auth_client_request.rb +44 -4
- data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/org_o_auth_client.rb +41 -1
- data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone_capabilities.rb +29 -4
- data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/presence_expand.rb +309 -0
- data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +12 -12
- 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 +26 -1
- 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_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 +26 -1
- 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 +26 -1
- 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/queue_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/recipient_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/recording_job_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/relationship_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/reporting_export_metadata_job_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/response.rb +2 -2
- data/lib/purecloudplatformclientv2/models/response_entity_list.rb +12 -12
- data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/scim_config_resource_type.rb +4 -30
- data/lib/purecloudplatformclientv2/models/scim_genesys_user_external_id.rb +229 -0
- data/lib/purecloudplatformclientv2/models/scim_phone_number.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_service_provider_config.rb +4 -30
- data/lib/purecloudplatformclientv2/models/scim_user_extensions.rb +33 -5
- data/lib/purecloudplatformclientv2/models/scim_v2_group.rb +4 -30
- data/lib/purecloudplatformclientv2/models/scim_v2_schema_definition.rb +4 -30
- data/lib/purecloudplatformclientv2/models/scim_v2_user.rb +4 -30
- data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/screenshare.rb +30 -4
- data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/segment_detail_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/sms_address_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/social_expression.rb +30 -4
- data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/subject_division_grants_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/text_message_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/tts_engine_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/tts_voice_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/twitter_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/update_coaching_appointment_request.rb +44 -4
- data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_app_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_search_request.rb +44 -4
- data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/video.rb +30 -4
- data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/web_chat_member_info_entity_list.rb +12 -12
- 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/whats_app_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +46 -4
- data/docs/ScimMetadata.md +0 -16
|
@@ -288,7 +288,7 @@ module PureCloud
|
|
|
288
288
|
# @option opts [Integer] :page_size The total page size requested (default to 25)
|
|
289
289
|
# @option opts [Integer] :page_number The page number requested (default to 1)
|
|
290
290
|
# @option opts [String] :sort_by variable name requested to sort by
|
|
291
|
-
# @option opts [Array<
|
|
291
|
+
# @option opts [Array<Object>] :expand variable name requested by expand list
|
|
292
292
|
# @option opts [String] :next_page next page token
|
|
293
293
|
# @option opts [String] :previous_page Previous page token
|
|
294
294
|
# @return [Integration]
|
|
@@ -304,7 +304,7 @@ module PureCloud
|
|
|
304
304
|
# @option opts [Integer] :page_size The total page size requested
|
|
305
305
|
# @option opts [Integer] :page_number The page number requested
|
|
306
306
|
# @option opts [String] :sort_by variable name requested to sort by
|
|
307
|
-
# @option opts [Array<
|
|
307
|
+
# @option opts [Array<Object>] :expand variable name requested by expand list
|
|
308
308
|
# @option opts [String] :next_page next page token
|
|
309
309
|
# @option opts [String] :previous_page Previous page token
|
|
310
310
|
# @return [Array<(Integration, Fixnum, Hash)>] Integration data, response status code and response headers
|
|
@@ -471,7 +471,7 @@ module PureCloud
|
|
|
471
471
|
# @option opts [Integer] :page_size The total page size requested (default to 25)
|
|
472
472
|
# @option opts [Integer] :page_number The page number requested (default to 1)
|
|
473
473
|
# @option opts [String] :sort_by variable name requested to sort by
|
|
474
|
-
# @option opts [Array<
|
|
474
|
+
# @option opts [Array<Object>] :expand variable name requested by expand list
|
|
475
475
|
# @option opts [String] :next_page next page token
|
|
476
476
|
# @option opts [String] :previous_page Previous page token
|
|
477
477
|
# @return [IntegrationEntityListing]
|
|
@@ -486,7 +486,7 @@ module PureCloud
|
|
|
486
486
|
# @option opts [Integer] :page_size The total page size requested
|
|
487
487
|
# @option opts [Integer] :page_number The page number requested
|
|
488
488
|
# @option opts [String] :sort_by variable name requested to sort by
|
|
489
|
-
# @option opts [Array<
|
|
489
|
+
# @option opts [Array<Object>] :expand variable name requested by expand list
|
|
490
490
|
# @option opts [String] :next_page next page token
|
|
491
491
|
# @option opts [String] :previous_page Previous page token
|
|
492
492
|
# @return [Array<(IntegrationEntityListing, Fixnum, Hash)>] IntegrationEntityListing data, response status code and response headers
|
|
@@ -1277,7 +1277,7 @@ module PureCloud
|
|
|
1277
1277
|
# @option opts [Integer] :page_number The page number requested (default to 1)
|
|
1278
1278
|
# @option opts [String] :next_page next page token
|
|
1279
1279
|
# @option opts [String] :previous_page Previous page token
|
|
1280
|
-
# @option opts [String] :sort_by Root level field name to sort on.
|
|
1280
|
+
# @option opts [String] :sort_by Root level field name to sort on. Only 'name' is supported on this endpoint.
|
|
1281
1281
|
# @option opts [String] :sort_order Direction to sort 'sortBy' field. (default to asc)
|
|
1282
1282
|
# @option opts [String] :secure Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions.
|
|
1283
1283
|
# @return [CategoryEntityListing]
|
|
@@ -1293,7 +1293,7 @@ module PureCloud
|
|
|
1293
1293
|
# @option opts [Integer] :page_number The page number requested
|
|
1294
1294
|
# @option opts [String] :next_page next page token
|
|
1295
1295
|
# @option opts [String] :previous_page Previous page token
|
|
1296
|
-
# @option opts [String] :sort_by Root level field name to sort on.
|
|
1296
|
+
# @option opts [String] :sort_by Root level field name to sort on. Only 'name' is supported on this endpoint.
|
|
1297
1297
|
# @option opts [String] :sort_order Direction to sort 'sortBy' field.
|
|
1298
1298
|
# @option opts [String] :secure Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions.
|
|
1299
1299
|
# @return [Array<(CategoryEntityListing, Fixnum, Hash)>] CategoryEntityListing data, response status code and response headers
|
|
@@ -1559,7 +1559,7 @@ module PureCloud
|
|
|
1559
1559
|
# @option opts [Integer] :page_size The total page size requested (default to 25)
|
|
1560
1560
|
# @option opts [Integer] :page_number The page number requested (default to 1)
|
|
1561
1561
|
# @option opts [String] :sort_by variable name requested to sort by
|
|
1562
|
-
# @option opts [Array<
|
|
1562
|
+
# @option opts [Array<Object>] :expand variable name requested by expand list
|
|
1563
1563
|
# @option opts [String] :next_page next page token
|
|
1564
1564
|
# @option opts [String] :previous_page Previous page token
|
|
1565
1565
|
# @return [ClientAppEntityListing]
|
|
@@ -1574,7 +1574,7 @@ module PureCloud
|
|
|
1574
1574
|
# @option opts [Integer] :page_size The total page size requested
|
|
1575
1575
|
# @option opts [Integer] :page_number The page number requested
|
|
1576
1576
|
# @option opts [String] :sort_by variable name requested to sort by
|
|
1577
|
-
# @option opts [Array<
|
|
1577
|
+
# @option opts [Array<Object>] :expand variable name requested by expand list
|
|
1578
1578
|
# @option opts [String] :next_page next page token
|
|
1579
1579
|
# @option opts [String] :previous_page Previous page token
|
|
1580
1580
|
# @return [Array<(ClientAppEntityListing, Fixnum, Hash)>] ClientAppEntityListing data, response status code and response headers
|
|
@@ -2957,7 +2957,7 @@ module PureCloud
|
|
|
2957
2957
|
# @option opts [Integer] :page_size The total page size requested (default to 25)
|
|
2958
2958
|
# @option opts [Integer] :page_number The page number requested (default to 1)
|
|
2959
2959
|
# @option opts [String] :sort_by variable name requested to sort by
|
|
2960
|
-
# @option opts [Array<
|
|
2960
|
+
# @option opts [Array<Object>] :expand variable name requested by expand list
|
|
2961
2961
|
# @option opts [String] :next_page next page token
|
|
2962
2962
|
# @option opts [String] :previous_page Previous page token
|
|
2963
2963
|
# @return [IntegrationTypeEntityListing]
|
|
@@ -2972,7 +2972,7 @@ module PureCloud
|
|
|
2972
2972
|
# @option opts [Integer] :page_size The total page size requested
|
|
2973
2973
|
# @option opts [Integer] :page_number The page number requested
|
|
2974
2974
|
# @option opts [String] :sort_by variable name requested to sort by
|
|
2975
|
-
# @option opts [Array<
|
|
2975
|
+
# @option opts [Array<Object>] :expand variable name requested by expand list
|
|
2976
2976
|
# @option opts [String] :next_page next page token
|
|
2977
2977
|
# @option opts [String] :previous_page Previous page token
|
|
2978
2978
|
# @return [Array<(IntegrationTypeEntityListing, Fixnum, Hash)>] IntegrationTypeEntityListing data, response status code and response headers
|
|
@@ -3066,7 +3066,7 @@ module PureCloud
|
|
|
3066
3066
|
# @option opts [Integer] :page_size The total page size requested (default to 25)
|
|
3067
3067
|
# @option opts [Integer] :page_number The page number requested (default to 1)
|
|
3068
3068
|
# @option opts [String] :sort_by variable name requested to sort by
|
|
3069
|
-
# @option opts [Array<
|
|
3069
|
+
# @option opts [Array<Object>] :expand variable name requested by expand list
|
|
3070
3070
|
# @option opts [String] :next_page next page token
|
|
3071
3071
|
# @option opts [String] :previous_page Previous page token
|
|
3072
3072
|
# @option opts [String] :app_host The type of UserApp to filter by
|
|
@@ -3082,7 +3082,7 @@ module PureCloud
|
|
|
3082
3082
|
# @option opts [Integer] :page_size The total page size requested
|
|
3083
3083
|
# @option opts [Integer] :page_number The page number requested
|
|
3084
3084
|
# @option opts [String] :sort_by variable name requested to sort by
|
|
3085
|
-
# @option opts [Array<
|
|
3085
|
+
# @option opts [Array<Object>] :expand variable name requested by expand list
|
|
3086
3086
|
# @option opts [String] :next_page next page token
|
|
3087
3087
|
# @option opts [String] :previous_page Previous page token
|
|
3088
3088
|
# @option opts [String] :app_host The type of UserApp to filter by
|
|
@@ -3186,7 +3186,7 @@ module PureCloud
|
|
|
3186
3186
|
# @option opts [Integer] :page_size The total page size requested (default to 25)
|
|
3187
3187
|
# @option opts [Integer] :page_number The page number requested (default to 1)
|
|
3188
3188
|
# @option opts [String] :sort_by variable name requested to sort by
|
|
3189
|
-
# @option opts [Array<
|
|
3189
|
+
# @option opts [Array<Object>] :expand variable name requested by expand list
|
|
3190
3190
|
# @option opts [String] :next_page next page token
|
|
3191
3191
|
# @option opts [String] :previous_page Previous page token
|
|
3192
3192
|
# @return [Integration]
|
|
@@ -3203,7 +3203,7 @@ module PureCloud
|
|
|
3203
3203
|
# @option opts [Integer] :page_size The total page size requested
|
|
3204
3204
|
# @option opts [Integer] :page_number The page number requested
|
|
3205
3205
|
# @option opts [String] :sort_by variable name requested to sort by
|
|
3206
|
-
# @option opts [Array<
|
|
3206
|
+
# @option opts [Array<Object>] :expand variable name requested by expand list
|
|
3207
3207
|
# @option opts [String] :next_page next page token
|
|
3208
3208
|
# @option opts [String] :previous_page Previous page token
|
|
3209
3209
|
# @return [Array<(Integration, Fixnum, Hash)>] Integration data, response status code and response headers
|
|
@@ -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 JourneyApi
|
|
21
|
+
attr_accessor :api_client
|
|
22
|
+
|
|
23
|
+
def initialize(api_client = ApiClient.default)
|
|
24
|
+
@api_client = api_client
|
|
25
|
+
end
|
|
26
|
+
|
|
27
|
+
# Query for journey aggregates
|
|
28
|
+
#
|
|
29
|
+
# @param body query
|
|
30
|
+
# @param [Hash] opts the optional parameters
|
|
31
|
+
# @return [JourneyAggregateQueryResponse]
|
|
32
|
+
def post_analytics_journeys_aggregates_query(body, opts = {})
|
|
33
|
+
data, _status_code, _headers = post_analytics_journeys_aggregates_query_with_http_info(body, opts)
|
|
34
|
+
return data
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
# Query for journey aggregates
|
|
38
|
+
#
|
|
39
|
+
# @param body query
|
|
40
|
+
# @param [Hash] opts the optional parameters
|
|
41
|
+
# @return [Array<(JourneyAggregateQueryResponse, Fixnum, Hash)>] JourneyAggregateQueryResponse data, response status code and response headers
|
|
42
|
+
def post_analytics_journeys_aggregates_query_with_http_info(body, opts = {})
|
|
43
|
+
if @api_client.config.debugging
|
|
44
|
+
@api_client.config.logger.debug "Calling API: JourneyApi.post_analytics_journeys_aggregates_query ..."
|
|
45
|
+
end
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
# verify the required parameter 'body' is set
|
|
49
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling JourneyApi.post_analytics_journeys_aggregates_query" if body.nil?
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
# resource path
|
|
56
|
+
local_var_path = "/api/v2/analytics/journeys/aggregates/query".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(body)
|
|
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 => 'JourneyAggregateQueryResponse')
|
|
86
|
+
if @api_client.config.debugging
|
|
87
|
+
@api_client.config.logger.debug "API called: JourneyApi#post_analytics_journeys_aggregates_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
88
|
+
end
|
|
89
|
+
return data, status_code, headers
|
|
90
|
+
end
|
|
91
|
+
end
|
|
92
|
+
end
|
|
@@ -177,11 +177,11 @@ module PureCloud
|
|
|
177
177
|
# @option opts [Integer] :page_size The total page size requested (default to 25)
|
|
178
178
|
# @option opts [Integer] :page_number The page number requested (default to 1)
|
|
179
179
|
# @option opts [String] :sort_by variable name requested to sort by
|
|
180
|
-
# @option opts [Array<
|
|
180
|
+
# @option opts [Array<Object>] :expand variable name requested by expand list
|
|
181
181
|
# @option opts [String] :next_page next page token
|
|
182
182
|
# @option opts [String] :previous_page Previous page token
|
|
183
183
|
# @option opts [BOOLEAN] :object_count Include the count of objects contained in the division (default to false)
|
|
184
|
-
# @option opts [Array<
|
|
184
|
+
# @option opts [Array<Object>] :id Optionally request specific divisions by their IDs
|
|
185
185
|
# @option opts [String] :name Search term to filter by division name
|
|
186
186
|
# @return [AuthzDivisionEntityListing]
|
|
187
187
|
def get_authorization_divisions(opts = {})
|
|
@@ -195,11 +195,11 @@ module PureCloud
|
|
|
195
195
|
# @option opts [Integer] :page_size The total page size requested
|
|
196
196
|
# @option opts [Integer] :page_number The page number requested
|
|
197
197
|
# @option opts [String] :sort_by variable name requested to sort by
|
|
198
|
-
# @option opts [Array<
|
|
198
|
+
# @option opts [Array<Object>] :expand variable name requested by expand list
|
|
199
199
|
# @option opts [String] :next_page next page token
|
|
200
200
|
# @option opts [String] :previous_page Previous page token
|
|
201
201
|
# @option opts [BOOLEAN] :object_count Include the count of objects contained in the division
|
|
202
|
-
# @option opts [Array<
|
|
202
|
+
# @option opts [Array<Object>] :id Optionally request specific divisions by their IDs
|
|
203
203
|
# @option opts [String] :name Search term to filter by division name
|
|
204
204
|
# @return [Array<(AuthzDivisionEntityListing, Fixnum, Hash)>] AuthzDivisionEntityListing data, response status code and response headers
|
|
205
205
|
def get_authorization_divisions_with_http_info(opts = {})
|
|
@@ -309,9 +309,9 @@ module PureCloud
|
|
|
309
309
|
end
|
|
310
310
|
|
|
311
311
|
# Get a user's Presence
|
|
312
|
-
#
|
|
312
|
+
# Get a user's presence for the specified source that is not specifically listed. Used to support custom presence sources.
|
|
313
313
|
# @param user_id user Id
|
|
314
|
-
# @param source_id
|
|
314
|
+
# @param source_id Presence source ID
|
|
315
315
|
# @param [Hash] opts the optional parameters
|
|
316
316
|
# @return [UserPresence]
|
|
317
317
|
def get_user_presence(user_id, source_id, opts = {})
|
|
@@ -320,9 +320,9 @@ module PureCloud
|
|
|
320
320
|
end
|
|
321
321
|
|
|
322
322
|
# Get a user's Presence
|
|
323
|
-
#
|
|
323
|
+
# Get a user's presence for the specified source that is not specifically listed. Used to support custom presence sources.
|
|
324
324
|
# @param user_id user Id
|
|
325
|
-
# @param source_id
|
|
325
|
+
# @param source_id Presence source ID
|
|
326
326
|
# @param [Hash] opts the optional parameters
|
|
327
327
|
# @return [Array<(UserPresence, Fixnum, Hash)>] UserPresence data, response status code and response headers
|
|
328
328
|
def get_user_presence_with_http_info(user_id, source_id, opts = {})
|
|
@@ -383,10 +383,140 @@ module PureCloud
|
|
|
383
383
|
return data, status_code, headers
|
|
384
384
|
end
|
|
385
385
|
|
|
386
|
+
# Get a user's Microsoft Teams presence.
|
|
387
|
+
# Gets the presence for a Microsoft Teams user. This will return the Microsoft Teams presence mapped to GenesysCloud presence with additional activity details in the message field. This presence source is read-only.
|
|
388
|
+
# @param user_id user Id
|
|
389
|
+
# @param [Hash] opts the optional parameters
|
|
390
|
+
# @return [PresenceExpand]
|
|
391
|
+
def get_user_presences_microsoftteams(user_id, opts = {})
|
|
392
|
+
data, _status_code, _headers = get_user_presences_microsoftteams_with_http_info(user_id, opts)
|
|
393
|
+
return data
|
|
394
|
+
end
|
|
395
|
+
|
|
396
|
+
# Get a user's Microsoft Teams presence.
|
|
397
|
+
# Gets the presence for a Microsoft Teams user. This will return the Microsoft Teams presence mapped to GenesysCloud presence with additional activity details in the message field. This presence source is read-only.
|
|
398
|
+
# @param user_id user Id
|
|
399
|
+
# @param [Hash] opts the optional parameters
|
|
400
|
+
# @return [Array<(PresenceExpand, Fixnum, Hash)>] PresenceExpand data, response status code and response headers
|
|
401
|
+
def get_user_presences_microsoftteams_with_http_info(user_id, opts = {})
|
|
402
|
+
if @api_client.config.debugging
|
|
403
|
+
@api_client.config.logger.debug "Calling API: PresenceApi.get_user_presences_microsoftteams ..."
|
|
404
|
+
end
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
# verify the required parameter 'user_id' is set
|
|
408
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling PresenceApi.get_user_presences_microsoftteams" if user_id.nil?
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
|
|
413
|
+
|
|
414
|
+
# resource path
|
|
415
|
+
local_var_path = "/api/v2/users/{userId}/presences/microsoftteams".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
|
|
416
|
+
|
|
417
|
+
# query parameters
|
|
418
|
+
query_params = {}
|
|
419
|
+
|
|
420
|
+
# header parameters
|
|
421
|
+
header_params = {}
|
|
422
|
+
|
|
423
|
+
# HTTP header 'Accept' (if needed)
|
|
424
|
+
local_header_accept = ['application/json']
|
|
425
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
|
426
|
+
|
|
427
|
+
# HTTP header 'Content-Type'
|
|
428
|
+
local_header_content_type = ['application/json']
|
|
429
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
|
430
|
+
|
|
431
|
+
# form parameters
|
|
432
|
+
form_params = {}
|
|
433
|
+
|
|
434
|
+
# http body (model)
|
|
435
|
+
post_body = nil
|
|
436
|
+
|
|
437
|
+
auth_names = ['PureCloud OAuth']
|
|
438
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
439
|
+
:header_params => header_params,
|
|
440
|
+
:query_params => query_params,
|
|
441
|
+
:form_params => form_params,
|
|
442
|
+
:body => post_body,
|
|
443
|
+
:auth_names => auth_names,
|
|
444
|
+
:return_type => 'PresenceExpand')
|
|
445
|
+
if @api_client.config.debugging
|
|
446
|
+
@api_client.config.logger.debug "API called: PresenceApi#get_user_presences_microsoftteams\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
447
|
+
end
|
|
448
|
+
return data, status_code, headers
|
|
449
|
+
end
|
|
450
|
+
|
|
451
|
+
# Get a user's GenesysCloud presence.
|
|
452
|
+
# Get the default GenesysCloud user presence source PURECLOUD
|
|
453
|
+
# @param user_id user Id
|
|
454
|
+
# @param [Hash] opts the optional parameters
|
|
455
|
+
# @return [UserPresence]
|
|
456
|
+
def get_user_presences_purecloud(user_id, opts = {})
|
|
457
|
+
data, _status_code, _headers = get_user_presences_purecloud_with_http_info(user_id, opts)
|
|
458
|
+
return data
|
|
459
|
+
end
|
|
460
|
+
|
|
461
|
+
# Get a user's GenesysCloud presence.
|
|
462
|
+
# Get the default GenesysCloud user presence source PURECLOUD
|
|
463
|
+
# @param user_id user Id
|
|
464
|
+
# @param [Hash] opts the optional parameters
|
|
465
|
+
# @return [Array<(UserPresence, Fixnum, Hash)>] UserPresence data, response status code and response headers
|
|
466
|
+
def get_user_presences_purecloud_with_http_info(user_id, opts = {})
|
|
467
|
+
if @api_client.config.debugging
|
|
468
|
+
@api_client.config.logger.debug "Calling API: PresenceApi.get_user_presences_purecloud ..."
|
|
469
|
+
end
|
|
470
|
+
|
|
471
|
+
|
|
472
|
+
# verify the required parameter 'user_id' is set
|
|
473
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling PresenceApi.get_user_presences_purecloud" if user_id.nil?
|
|
474
|
+
|
|
475
|
+
|
|
476
|
+
|
|
477
|
+
|
|
478
|
+
|
|
479
|
+
# resource path
|
|
480
|
+
local_var_path = "/api/v2/users/{userId}/presences/purecloud".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
|
|
481
|
+
|
|
482
|
+
# query parameters
|
|
483
|
+
query_params = {}
|
|
484
|
+
|
|
485
|
+
# header parameters
|
|
486
|
+
header_params = {}
|
|
487
|
+
|
|
488
|
+
# HTTP header 'Accept' (if needed)
|
|
489
|
+
local_header_accept = ['application/json']
|
|
490
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
|
491
|
+
|
|
492
|
+
# HTTP header 'Content-Type'
|
|
493
|
+
local_header_content_type = ['application/json']
|
|
494
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
|
495
|
+
|
|
496
|
+
# form parameters
|
|
497
|
+
form_params = {}
|
|
498
|
+
|
|
499
|
+
# http body (model)
|
|
500
|
+
post_body = nil
|
|
501
|
+
|
|
502
|
+
auth_names = ['PureCloud OAuth']
|
|
503
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
504
|
+
:header_params => header_params,
|
|
505
|
+
:query_params => query_params,
|
|
506
|
+
:form_params => form_params,
|
|
507
|
+
:body => post_body,
|
|
508
|
+
:auth_names => auth_names,
|
|
509
|
+
:return_type => 'UserPresence')
|
|
510
|
+
if @api_client.config.debugging
|
|
511
|
+
@api_client.config.logger.debug "API called: PresenceApi#get_user_presences_purecloud\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
512
|
+
end
|
|
513
|
+
return data, status_code, headers
|
|
514
|
+
end
|
|
515
|
+
|
|
386
516
|
# Patch a user's Presence
|
|
387
|
-
# The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the 'source' defined in the path as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.
|
|
517
|
+
# Patch a user's presence for the specified source that is not specifically listed. The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the 'source' defined in the path as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.
|
|
388
518
|
# @param user_id user Id
|
|
389
|
-
# @param source_id
|
|
519
|
+
# @param source_id Presence source ID
|
|
390
520
|
# @param body User presence
|
|
391
521
|
# @param [Hash] opts the optional parameters
|
|
392
522
|
# @return [UserPresence]
|
|
@@ -396,9 +526,9 @@ module PureCloud
|
|
|
396
526
|
end
|
|
397
527
|
|
|
398
528
|
# Patch a user's Presence
|
|
399
|
-
# The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the 'source' defined in the path as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.
|
|
529
|
+
# Patch a user's presence for the specified source that is not specifically listed. The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the 'source' defined in the path as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.
|
|
400
530
|
# @param user_id user Id
|
|
401
|
-
# @param source_id
|
|
531
|
+
# @param source_id Presence source ID
|
|
402
532
|
# @param body User presence
|
|
403
533
|
# @param [Hash] opts the optional parameters
|
|
404
534
|
# @return [Array<(UserPresence, Fixnum, Hash)>] UserPresence data, response status code and response headers
|
|
@@ -468,6 +598,81 @@ module PureCloud
|
|
|
468
598
|
return data, status_code, headers
|
|
469
599
|
end
|
|
470
600
|
|
|
601
|
+
# Patch a GenesysCloud user's presence
|
|
602
|
+
# The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the PURECLOUD source as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.
|
|
603
|
+
# @param user_id user Id
|
|
604
|
+
# @param body User presence
|
|
605
|
+
# @param [Hash] opts the optional parameters
|
|
606
|
+
# @return [UserPresence]
|
|
607
|
+
def patch_user_presences_purecloud(user_id, body, opts = {})
|
|
608
|
+
data, _status_code, _headers = patch_user_presences_purecloud_with_http_info(user_id, body, opts)
|
|
609
|
+
return data
|
|
610
|
+
end
|
|
611
|
+
|
|
612
|
+
# Patch a GenesysCloud user's presence
|
|
613
|
+
# The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the PURECLOUD source as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.
|
|
614
|
+
# @param user_id user Id
|
|
615
|
+
# @param body User presence
|
|
616
|
+
# @param [Hash] opts the optional parameters
|
|
617
|
+
# @return [Array<(UserPresence, Fixnum, Hash)>] UserPresence data, response status code and response headers
|
|
618
|
+
def patch_user_presences_purecloud_with_http_info(user_id, body, opts = {})
|
|
619
|
+
if @api_client.config.debugging
|
|
620
|
+
@api_client.config.logger.debug "Calling API: PresenceApi.patch_user_presences_purecloud ..."
|
|
621
|
+
end
|
|
622
|
+
|
|
623
|
+
|
|
624
|
+
# verify the required parameter 'user_id' is set
|
|
625
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling PresenceApi.patch_user_presences_purecloud" if user_id.nil?
|
|
626
|
+
|
|
627
|
+
|
|
628
|
+
|
|
629
|
+
|
|
630
|
+
|
|
631
|
+
|
|
632
|
+
# verify the required parameter 'body' is set
|
|
633
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling PresenceApi.patch_user_presences_purecloud" if body.nil?
|
|
634
|
+
|
|
635
|
+
|
|
636
|
+
|
|
637
|
+
|
|
638
|
+
|
|
639
|
+
# resource path
|
|
640
|
+
local_var_path = "/api/v2/users/{userId}/presences/purecloud".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
|
|
641
|
+
|
|
642
|
+
# query parameters
|
|
643
|
+
query_params = {}
|
|
644
|
+
|
|
645
|
+
# header parameters
|
|
646
|
+
header_params = {}
|
|
647
|
+
|
|
648
|
+
# HTTP header 'Accept' (if needed)
|
|
649
|
+
local_header_accept = ['application/json']
|
|
650
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
|
651
|
+
|
|
652
|
+
# HTTP header 'Content-Type'
|
|
653
|
+
local_header_content_type = ['application/json']
|
|
654
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
|
655
|
+
|
|
656
|
+
# form parameters
|
|
657
|
+
form_params = {}
|
|
658
|
+
|
|
659
|
+
# http body (model)
|
|
660
|
+
post_body = @api_client.object_to_http_body(body)
|
|
661
|
+
|
|
662
|
+
auth_names = ['PureCloud OAuth']
|
|
663
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
|
|
664
|
+
:header_params => header_params,
|
|
665
|
+
:query_params => query_params,
|
|
666
|
+
:form_params => form_params,
|
|
667
|
+
:body => post_body,
|
|
668
|
+
:auth_names => auth_names,
|
|
669
|
+
:return_type => 'UserPresence')
|
|
670
|
+
if @api_client.config.debugging
|
|
671
|
+
@api_client.config.logger.debug "API called: PresenceApi#patch_user_presences_purecloud\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
672
|
+
end
|
|
673
|
+
return data, status_code, headers
|
|
674
|
+
end
|
|
675
|
+
|
|
471
676
|
# Create a Presence Definition
|
|
472
677
|
#
|
|
473
678
|
# @param body The Presence Definition to create
|