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
|
@@ -14,8 +14,8 @@ title: ExtensionPoolEntityListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
|
18
17
|
| **previous_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/ExternalContactsApi.md
CHANGED
|
@@ -35,6 +35,10 @@ Method | Description
|
|
|
35
35
|
[**get_externalcontacts_organizations_schemas**](ExternalContactsApi.html#get_externalcontacts_organizations_schemas) | Get a list of schemas.
|
|
36
36
|
[**get_externalcontacts_relationship**](ExternalContactsApi.html#get_externalcontacts_relationship) | Fetch a relationship
|
|
37
37
|
[**get_externalcontacts_reversewhitepageslookup**](ExternalContactsApi.html#get_externalcontacts_reversewhitepageslookup) | Look up contacts and externalOrganizations based on an attribute. Maximum of 25 values returned.
|
|
38
|
+
[**get_externalcontacts_scan_contacts**](ExternalContactsApi.html#get_externalcontacts_scan_contacts) | Scan for external contacts using paging
|
|
39
|
+
[**get_externalcontacts_scan_notes**](ExternalContactsApi.html#get_externalcontacts_scan_notes) | Scan for notes using paging
|
|
40
|
+
[**get_externalcontacts_scan_organizations**](ExternalContactsApi.html#get_externalcontacts_scan_organizations) | Scan for external organizations using paging
|
|
41
|
+
[**get_externalcontacts_scan_relationships**](ExternalContactsApi.html#get_externalcontacts_scan_relationships) | Scan for relationships
|
|
38
42
|
[**post_externalcontacts_contact_notes**](ExternalContactsApi.html#post_externalcontacts_contact_notes) | Create a note for an external contact
|
|
39
43
|
[**post_externalcontacts_contacts**](ExternalContactsApi.html#post_externalcontacts_contacts) | Create an external contact
|
|
40
44
|
[**post_externalcontacts_contacts_schemas**](ExternalContactsApi.html#post_externalcontacts_contacts_schemas) | Create a schema
|
|
@@ -1907,6 +1911,278 @@ Name | Type | Description | Notes
|
|
|
1907
1911
|
|
|
1908
1912
|
|
|
1909
1913
|
|
|
1914
|
+
<a name="get_externalcontacts_scan_contacts"></a>
|
|
1915
|
+
|
|
1916
|
+
## [**CursorContactListing**](CursorContactListing.html) get_externalcontacts_scan_contacts(opts)
|
|
1917
|
+
|
|
1918
|
+
|
|
1919
|
+
|
|
1920
|
+
Scan for external contacts using paging
|
|
1921
|
+
|
|
1922
|
+
|
|
1923
|
+
|
|
1924
|
+
Wraps GET /api/v2/externalcontacts/scan/contacts
|
|
1925
|
+
|
|
1926
|
+
Requires ANY permissions:
|
|
1927
|
+
|
|
1928
|
+
* externalContacts:contact:view
|
|
1929
|
+
|
|
1930
|
+
|
|
1931
|
+
### Example
|
|
1932
|
+
```{"language":"ruby"}
|
|
1933
|
+
# load the gem
|
|
1934
|
+
require 'purecloudplatformclientv2'
|
|
1935
|
+
# setup authorization
|
|
1936
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1937
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1938
|
+
environment = "mypurecloud.com"
|
|
1939
|
+
|
|
1940
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1941
|
+
|
|
1942
|
+
PureCloud.configure do |config|
|
|
1943
|
+
config.access_token = @authToken
|
|
1944
|
+
end
|
|
1945
|
+
|
|
1946
|
+
api_instance = PureCloud::ExternalContactsApi.new
|
|
1947
|
+
|
|
1948
|
+
opts = {
|
|
1949
|
+
limit: 56, # Integer | The number of contacts per page; must be between 10 and 200, default is 100)
|
|
1950
|
+
cursor: "cursor_example" # String | Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
|
|
1951
|
+
}
|
|
1952
|
+
|
|
1953
|
+
begin
|
|
1954
|
+
#Scan for external contacts using paging
|
|
1955
|
+
result = api_instance.get_externalcontacts_scan_contacts(opts)
|
|
1956
|
+
p result
|
|
1957
|
+
rescue PureCloud::ApiError => e
|
|
1958
|
+
puts "Exception when calling ExternalContactsApi->get_externalcontacts_scan_contacts: #{e}"
|
|
1959
|
+
end
|
|
1960
|
+
```
|
|
1961
|
+
|
|
1962
|
+
### Parameters
|
|
1963
|
+
|
|
1964
|
+
Name | Type | Description | Notes
|
|
1965
|
+
------------- | ------------- | ------------- | -------------
|
|
1966
|
+
**limit** | **Integer**| The number of contacts per page; must be between 10 and 200, default is 100) | [optional] |
|
|
1967
|
+
**cursor** | **String**| Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL | [optional] |
|
|
1968
|
+
{: class="table table-striped"}
|
|
1969
|
+
|
|
1970
|
+
|
|
1971
|
+
### Return type
|
|
1972
|
+
|
|
1973
|
+
[**CursorContactListing**](CursorContactListing.html)
|
|
1974
|
+
|
|
1975
|
+
### HTTP request headers
|
|
1976
|
+
|
|
1977
|
+
- **Content-Type**: application/json
|
|
1978
|
+
- **Accept**: application/json
|
|
1979
|
+
|
|
1980
|
+
|
|
1981
|
+
|
|
1982
|
+
<a name="get_externalcontacts_scan_notes"></a>
|
|
1983
|
+
|
|
1984
|
+
## [**CursorNoteListing**](CursorNoteListing.html) get_externalcontacts_scan_notes(opts)
|
|
1985
|
+
|
|
1986
|
+
|
|
1987
|
+
|
|
1988
|
+
Scan for notes using paging
|
|
1989
|
+
|
|
1990
|
+
|
|
1991
|
+
|
|
1992
|
+
Wraps GET /api/v2/externalcontacts/scan/notes
|
|
1993
|
+
|
|
1994
|
+
Requires ANY permissions:
|
|
1995
|
+
|
|
1996
|
+
* externalContacts:contact:view
|
|
1997
|
+
|
|
1998
|
+
|
|
1999
|
+
### Example
|
|
2000
|
+
```{"language":"ruby"}
|
|
2001
|
+
# load the gem
|
|
2002
|
+
require 'purecloudplatformclientv2'
|
|
2003
|
+
# setup authorization
|
|
2004
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2005
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2006
|
+
environment = "mypurecloud.com"
|
|
2007
|
+
|
|
2008
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2009
|
+
|
|
2010
|
+
PureCloud.configure do |config|
|
|
2011
|
+
config.access_token = @authToken
|
|
2012
|
+
end
|
|
2013
|
+
|
|
2014
|
+
api_instance = PureCloud::ExternalContactsApi.new
|
|
2015
|
+
|
|
2016
|
+
opts = {
|
|
2017
|
+
limit: 56, # Integer | The number of notes per page; must be between 10 and 200, default is 100)
|
|
2018
|
+
cursor: "cursor_example" # String | Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
|
|
2019
|
+
}
|
|
2020
|
+
|
|
2021
|
+
begin
|
|
2022
|
+
#Scan for notes using paging
|
|
2023
|
+
result = api_instance.get_externalcontacts_scan_notes(opts)
|
|
2024
|
+
p result
|
|
2025
|
+
rescue PureCloud::ApiError => e
|
|
2026
|
+
puts "Exception when calling ExternalContactsApi->get_externalcontacts_scan_notes: #{e}"
|
|
2027
|
+
end
|
|
2028
|
+
```
|
|
2029
|
+
|
|
2030
|
+
### Parameters
|
|
2031
|
+
|
|
2032
|
+
Name | Type | Description | Notes
|
|
2033
|
+
------------- | ------------- | ------------- | -------------
|
|
2034
|
+
**limit** | **Integer**| The number of notes per page; must be between 10 and 200, default is 100) | [optional] |
|
|
2035
|
+
**cursor** | **String**| Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL | [optional] |
|
|
2036
|
+
{: class="table table-striped"}
|
|
2037
|
+
|
|
2038
|
+
|
|
2039
|
+
### Return type
|
|
2040
|
+
|
|
2041
|
+
[**CursorNoteListing**](CursorNoteListing.html)
|
|
2042
|
+
|
|
2043
|
+
### HTTP request headers
|
|
2044
|
+
|
|
2045
|
+
- **Content-Type**: application/json
|
|
2046
|
+
- **Accept**: application/json
|
|
2047
|
+
|
|
2048
|
+
|
|
2049
|
+
|
|
2050
|
+
<a name="get_externalcontacts_scan_organizations"></a>
|
|
2051
|
+
|
|
2052
|
+
## [**CursorOrganizationListing**](CursorOrganizationListing.html) get_externalcontacts_scan_organizations(opts)
|
|
2053
|
+
|
|
2054
|
+
|
|
2055
|
+
|
|
2056
|
+
Scan for external organizations using paging
|
|
2057
|
+
|
|
2058
|
+
|
|
2059
|
+
|
|
2060
|
+
Wraps GET /api/v2/externalcontacts/scan/organizations
|
|
2061
|
+
|
|
2062
|
+
Requires ANY permissions:
|
|
2063
|
+
|
|
2064
|
+
* externalContacts:externalOrganization:view
|
|
2065
|
+
|
|
2066
|
+
|
|
2067
|
+
### Example
|
|
2068
|
+
```{"language":"ruby"}
|
|
2069
|
+
# load the gem
|
|
2070
|
+
require 'purecloudplatformclientv2'
|
|
2071
|
+
# setup authorization
|
|
2072
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2073
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2074
|
+
environment = "mypurecloud.com"
|
|
2075
|
+
|
|
2076
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2077
|
+
|
|
2078
|
+
PureCloud.configure do |config|
|
|
2079
|
+
config.access_token = @authToken
|
|
2080
|
+
end
|
|
2081
|
+
|
|
2082
|
+
api_instance = PureCloud::ExternalContactsApi.new
|
|
2083
|
+
|
|
2084
|
+
opts = {
|
|
2085
|
+
limit: 56, # Integer | The number of organizations per page; must be between 10 and 200, default is 100)
|
|
2086
|
+
cursor: "cursor_example" # String | Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
|
|
2087
|
+
}
|
|
2088
|
+
|
|
2089
|
+
begin
|
|
2090
|
+
#Scan for external organizations using paging
|
|
2091
|
+
result = api_instance.get_externalcontacts_scan_organizations(opts)
|
|
2092
|
+
p result
|
|
2093
|
+
rescue PureCloud::ApiError => e
|
|
2094
|
+
puts "Exception when calling ExternalContactsApi->get_externalcontacts_scan_organizations: #{e}"
|
|
2095
|
+
end
|
|
2096
|
+
```
|
|
2097
|
+
|
|
2098
|
+
### Parameters
|
|
2099
|
+
|
|
2100
|
+
Name | Type | Description | Notes
|
|
2101
|
+
------------- | ------------- | ------------- | -------------
|
|
2102
|
+
**limit** | **Integer**| The number of organizations per page; must be between 10 and 200, default is 100) | [optional] |
|
|
2103
|
+
**cursor** | **String**| Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL | [optional] |
|
|
2104
|
+
{: class="table table-striped"}
|
|
2105
|
+
|
|
2106
|
+
|
|
2107
|
+
### Return type
|
|
2108
|
+
|
|
2109
|
+
[**CursorOrganizationListing**](CursorOrganizationListing.html)
|
|
2110
|
+
|
|
2111
|
+
### HTTP request headers
|
|
2112
|
+
|
|
2113
|
+
- **Content-Type**: application/json
|
|
2114
|
+
- **Accept**: application/json
|
|
2115
|
+
|
|
2116
|
+
|
|
2117
|
+
|
|
2118
|
+
<a name="get_externalcontacts_scan_relationships"></a>
|
|
2119
|
+
|
|
2120
|
+
## [**CursorRelationshipListing**](CursorRelationshipListing.html) get_externalcontacts_scan_relationships(opts)
|
|
2121
|
+
|
|
2122
|
+
|
|
2123
|
+
|
|
2124
|
+
Scan for relationships
|
|
2125
|
+
|
|
2126
|
+
|
|
2127
|
+
|
|
2128
|
+
Wraps GET /api/v2/externalcontacts/scan/relationships
|
|
2129
|
+
|
|
2130
|
+
Requires ANY permissions:
|
|
2131
|
+
|
|
2132
|
+
* externalContacts:contact:view
|
|
2133
|
+
|
|
2134
|
+
|
|
2135
|
+
### Example
|
|
2136
|
+
```{"language":"ruby"}
|
|
2137
|
+
# load the gem
|
|
2138
|
+
require 'purecloudplatformclientv2'
|
|
2139
|
+
# setup authorization
|
|
2140
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2141
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2142
|
+
environment = "mypurecloud.com"
|
|
2143
|
+
|
|
2144
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2145
|
+
|
|
2146
|
+
PureCloud.configure do |config|
|
|
2147
|
+
config.access_token = @authToken
|
|
2148
|
+
end
|
|
2149
|
+
|
|
2150
|
+
api_instance = PureCloud::ExternalContactsApi.new
|
|
2151
|
+
|
|
2152
|
+
opts = {
|
|
2153
|
+
limit: 56, # Integer | The number of relationships per page; must be between 10 and 200, default is 100)
|
|
2154
|
+
cursor: "cursor_example" # String | Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
|
|
2155
|
+
}
|
|
2156
|
+
|
|
2157
|
+
begin
|
|
2158
|
+
#Scan for relationships
|
|
2159
|
+
result = api_instance.get_externalcontacts_scan_relationships(opts)
|
|
2160
|
+
p result
|
|
2161
|
+
rescue PureCloud::ApiError => e
|
|
2162
|
+
puts "Exception when calling ExternalContactsApi->get_externalcontacts_scan_relationships: #{e}"
|
|
2163
|
+
end
|
|
2164
|
+
```
|
|
2165
|
+
|
|
2166
|
+
### Parameters
|
|
2167
|
+
|
|
2168
|
+
Name | Type | Description | Notes
|
|
2169
|
+
------------- | ------------- | ------------- | -------------
|
|
2170
|
+
**limit** | **Integer**| The number of relationships per page; must be between 10 and 200, default is 100) | [optional] |
|
|
2171
|
+
**cursor** | **String**| Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL | [optional] |
|
|
2172
|
+
{: class="table table-striped"}
|
|
2173
|
+
|
|
2174
|
+
|
|
2175
|
+
### Return type
|
|
2176
|
+
|
|
2177
|
+
[**CursorRelationshipListing**](CursorRelationshipListing.html)
|
|
2178
|
+
|
|
2179
|
+
### HTTP request headers
|
|
2180
|
+
|
|
2181
|
+
- **Content-Type**: application/json
|
|
2182
|
+
- **Accept**: application/json
|
|
2183
|
+
|
|
2184
|
+
|
|
2185
|
+
|
|
1910
2186
|
<a name="post_externalcontacts_contact_notes"></a>
|
|
1911
2187
|
|
|
1912
2188
|
## [**Note**](Note.html) post_externalcontacts_contact_notes(contact_id, body)
|
|
@@ -2579,7 +2855,7 @@ Name | Type | Description | Notes
|
|
|
2579
2855
|
|
|
2580
2856
|
<a name="put_externalcontacts_conversation"></a>
|
|
2581
2857
|
|
|
2582
|
-
## put_externalcontacts_conversation(
|
|
2858
|
+
## put_externalcontacts_conversation(body, conversation_id)
|
|
2583
2859
|
|
|
2584
2860
|
|
|
2585
2861
|
|
|
@@ -2611,14 +2887,14 @@ end
|
|
|
2611
2887
|
|
|
2612
2888
|
api_instance = PureCloud::ExternalContactsApi.new
|
|
2613
2889
|
|
|
2614
|
-
conversation_id = "conversation_id_example" # String | Conversation ID
|
|
2615
|
-
|
|
2616
2890
|
body = PureCloud::ConversationAssociation.new # ConversationAssociation | ConversationAssociation
|
|
2617
2891
|
|
|
2892
|
+
conversation_id = "conversation_id_example" # String | Conversation ID
|
|
2893
|
+
|
|
2618
2894
|
|
|
2619
2895
|
begin
|
|
2620
2896
|
#Associate/disassociate an external contact with a conversation
|
|
2621
|
-
api_instance.put_externalcontacts_conversation(
|
|
2897
|
+
api_instance.put_externalcontacts_conversation(body, conversation_id)
|
|
2622
2898
|
rescue PureCloud::ApiError => e
|
|
2623
2899
|
puts "Exception when calling ExternalContactsApi->put_externalcontacts_conversation: #{e}"
|
|
2624
2900
|
end
|
|
@@ -2628,8 +2904,8 @@ end
|
|
|
2628
2904
|
|
|
2629
2905
|
Name | Type | Description | Notes
|
|
2630
2906
|
------------- | ------------- | ------------- | -------------
|
|
2631
|
-
**conversation_id** | **String**| Conversation ID | |
|
|
2632
2907
|
**body** | [**ConversationAssociation**](ConversationAssociation.html)| ConversationAssociation | |
|
|
2908
|
+
**conversation_id** | **String**| Conversation ID | |
|
|
2633
2909
|
{: class="table table-striped"}
|
|
2634
2910
|
|
|
2635
2911
|
|
|
@@ -14,8 +14,8 @@ title: ExternalOrganizationListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
|
18
17
|
| **previous_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -14,8 +14,8 @@ title: FacebookIntegrationEntityListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
|
18
17
|
| **previous_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: FacebookIntegrationUpdateRequest
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::FacebookIntegrationUpdateRequest
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **page_access_token** | **String** | The long-lived Page Access Token of a facebook page. See https://developers.facebook.com/docs/facebook-login/access-tokens. Either pageAccessToken or userAccessToken should be provided. | [optional] |
|
|
11
|
+
| **user_access_token** | **String** | The short-lived User Access Token of the facebook user logged into the facebook app. See https://developers.facebook.com/docs/facebook-login/access-tokens. Either pageAccessToken or userAccessToken should be provided. | [optional] |
|
|
12
|
+
{: class="table table-striped"}
|
|
13
|
+
|
|
14
|
+
|
|
@@ -14,8 +14,8 @@ title: FaxDocumentEntityListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
|
18
17
|
| **previous_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -14,8 +14,8 @@ title: FlowDivisionViewEntityListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
|
18
17
|
| **previous_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/FlowEntityListing.md
CHANGED
|
@@ -14,8 +14,8 @@ title: FlowEntityListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
|
18
17
|
| **previous_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/FlowOutcomeListing.md
CHANGED
|
@@ -14,8 +14,8 @@ title: FlowOutcomeListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
|
18
17
|
| **previous_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -14,8 +14,8 @@ title: FlowVersionEntityListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
|
18
17
|
| **previous_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -14,8 +14,8 @@ title: GDPRRequestEntityListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
|
18
17
|
| **previous_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -14,8 +14,8 @@ title: GDPRSubjectEntityListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
|
18
17
|
| **previous_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/GreetingListing.md
CHANGED
|
@@ -14,8 +14,8 @@ title: GreetingListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
|
18
17
|
| **previous_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|