purecloudplatformclientv2 68.0.0 → 69.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/AgentActivityEntityListing.md +1 -1
- data/docs/ArchitectApi.md +3 -1
- data/docs/AttemptLimitsEntityListing.md +1 -1
- data/docs/AuthzDivisionEntityListing.md +1 -1
- data/docs/CalibrationEntityListing.md +1 -1
- data/docs/CallConversationEntityListing.md +1 -1
- data/docs/CallHistoryConversationEntityListing.md +1 -1
- data/docs/CallMediaParticipant.md +2 -0
- data/docs/CallableTimeSetEntityListing.md +1 -1
- data/docs/CallbackConversationEntityListing.md +1 -1
- data/docs/CallbackMediaParticipant.md +2 -0
- 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/ChatConversationEntityListing.md +1 -1
- data/docs/ChatMediaParticipant.md +2 -0
- data/docs/ClientAppEntityListing.md +1 -1
- data/docs/CobrowseConversationEntityListing.md +1 -1
- data/docs/CobrowseMediaParticipant.md +2 -0
- data/docs/CommandStatusEntityListing.md +1 -1
- data/docs/ConsumedResourcesEntityListing.md +1 -1
- data/docs/ConsumingResourcesEntityListing.md +1 -1
- 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/ConversationAggregationQuery.md +1 -0
- data/docs/ConversationCallEventTopicCallMediaParticipant.md +2 -0
- data/docs/ConversationCallbackEventTopicCallbackMediaParticipant.md +2 -0
- data/docs/ConversationChatEventTopicChatMediaParticipant.md +2 -0
- data/docs/ConversationCobrowseEventTopicCobrowseMediaParticipant.md +2 -0
- data/docs/ConversationDeletionProtectionQuery.md +13 -0
- data/docs/ConversationEmailEventTopicEmailMediaParticipant.md +2 -0
- data/docs/ConversationEntityListing.md +1 -1
- data/docs/ConversationEventTopicParticipant.md +2 -0
- data/docs/ConversationMessageEventTopicMessageMediaParticipant.md +2 -0
- data/docs/ConversationScreenShareEventTopicScreenShareMediaParticipant.md +2 -0
- data/docs/ConversationSocialExpressionEventTopicSocialMediaParticipant.md +2 -0
- data/docs/ConversationVideoEventTopicVideoMediaParticipant.md +2 -0
- data/docs/CredentialInfoListing.md +1 -1
- data/docs/CredentialTypeListing.md +1 -1
- 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/DialerResponsesetConfigChangeResponseSet.md +1 -0
- data/docs/DialogflowAgentSummaryEntityListing.md +1 -1
- data/docs/DirectoryUserDevicesListing.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/DomainLogicalInterface.md +3 -0
- data/docs/EdgeEntityListing.md +1 -1
- data/docs/EdgeGroupEntityListing.md +1 -1
- data/docs/EdgeLineEntityListing.md +1 -1
- data/docs/EmailConversationEntityListing.md +1 -1
- data/docs/EmailMediaParticipant.md +2 -0
- 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/EvaluationQuestion.md +1 -1
- data/docs/EvaluatorActivityEntityListing.md +1 -1
- data/docs/ExtensionEntityListing.md +1 -1
- data/docs/ExtensionPoolEntityListing.md +1 -1
- data/docs/ExternalOrganizationListing.md +1 -1
- data/docs/FacebookIntegrationEntityListing.md +1 -1
- data/docs/FaxDocumentEntityListing.md +1 -1
- data/docs/FlowAggregationQuery.md +1 -0
- data/docs/FlowDivisionView.md +2 -0
- 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/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/InteractionStatsAlertContainer.md +1 -1
- data/docs/InteractionStatsRuleContainer.md +1 -1
- 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/{LocationCreateUpdateDefinition.md → LocationCreateDefinition.md} +3 -4
- data/docs/LocationEntityListing.md +1 -1
- data/docs/LocationUpdateDefinition.md +20 -0
- data/docs/LocationsApi.md +4 -4
- data/docs/LogicalInterfaceEntityListing.md +1 -1
- data/docs/ManagementUnitListing.md +1 -1
- data/docs/MessageConversationEntityListing.md +1 -1
- data/docs/MessageEvaluation.md +16 -0
- data/docs/MessageMediaParticipant.md +2 -0
- data/docs/MessagingIntegrationEntityListing.md +1 -1
- data/docs/MessagingStickerEntityListing.md +1 -1
- data/docs/NoteListing.md +1 -1
- data/docs/OAuthClientEntityListing.md +1 -1
- data/docs/OAuthProviderEntityListing.md +1 -1
- 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/Participant.md +2 -0
- data/docs/ParticipantBasic.md +2 -0
- data/docs/PermissionCollectionEntityListing.md +1 -1
- data/docs/PhoneBaseEntityListing.md +1 -1
- 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/PromptAssetEntityListing.md +1 -1
- data/docs/PromptEntityListing.md +1 -1
- data/docs/QualityApi.md +51 -23
- data/docs/QualityAuditPage.md +1 -1
- data/docs/QueueConversationCallEventTopicCallMediaParticipant.md +2 -0
- data/docs/QueueConversationCallbackEventTopicCallbackMediaParticipant.md +2 -0
- data/docs/QueueConversationChatEventTopicChatMediaParticipant.md +2 -0
- data/docs/QueueConversationCobrowseEventTopicCobrowseMediaParticipant.md +2 -0
- data/docs/QueueConversationEmailEventTopicEmailMediaParticipant.md +2 -0
- data/docs/QueueConversationEventTopicParticipant.md +2 -0
- data/docs/QueueConversationMessageEventTopicMessageMediaParticipant.md +2 -0
- data/docs/QueueConversationScreenShareEventTopicScreenShareMediaParticipant.md +2 -0
- data/docs/QueueConversationSocialExpressionEventTopicParticipant.md +2 -0
- data/docs/QueueConversationVideoEventTopicParticipant.md +2 -0
- data/docs/QueueEntityListing.md +1 -1
- data/docs/QueueMemberEntityListing.md +1 -1
- data/docs/QueueUserEventTopicQueueMember.md +4 -4
- data/docs/QueueUserEventTopicUserReference.md +13 -0
- data/docs/RecipientListing.md +1 -1
- data/docs/RecordingApi.md +164 -14
- 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/ReportingExportJobRequest.md +1 -0
- data/docs/ReportingExportJobResponse.md +1 -0
- data/docs/ResponseEntityList.md +1 -1
- data/docs/ResponseEntityListing.md +1 -1
- data/docs/ResponseSetEntityListing.md +1 -1
- data/docs/RoutingApi.md +0 -2
- data/docs/RuleSetEntityListing.md +1 -1
- 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/ScimConfigResourceTypeSchemaExtension.md +1 -1
- data/docs/ScimServiceProviderConfig.md +6 -6
- data/docs/ScreenRecordingSessionListing.md +1 -1
- data/docs/ScriptEntityListing.md +1 -1
- data/docs/SecurityProfileEntityListing.md +1 -1
- data/docs/SelectedColumns.md +14 -0
- 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/SmsPhoneNumber.md +1 -0
- data/docs/SmsPhoneNumberEntityListing.md +1 -1
- data/docs/StationEntityListing.md +1 -1
- data/docs/StationsApi.md +1 -2
- data/docs/SubjectDivisionGrantsEntityListing.md +1 -1
- data/docs/SubscriptionOverviewUsage.md +2 -0
- data/docs/SurveyAggregationQuery.md +1 -0
- 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/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/UserActionCategoryEntityListing.md +1 -1
- data/docs/UserAggregationQuery.md +1 -0
- 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/UserSkillEntityListing.md +1 -1
- data/docs/UsersApi.md +0 -345
- data/docs/VoicemailMessageEntityListing.md +1 -1
- data/docs/WebChatMemberInfoEntityList.md +1 -1
- data/docs/WebChatMessageEntityList.md +1 -1
- 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 +6 -2
- data/lib/purecloudplatformclientv2/api/architect_api.rb +9 -0
- data/lib/purecloudplatformclientv2/api/quality_api.rb +4 -4
- data/lib/purecloudplatformclientv2/api/recording_api.rb +138 -2
- data/lib/purecloudplatformclientv2/api/routing_api.rb +0 -9
- data/lib/purecloudplatformclientv2/api/users_api.rb +0 -383
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +12 -12
- 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/calibration_entity_listing.rb +12 -12
- 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/call_media_participant.rb +53 -1
- data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/callback_media_participant.rb +53 -1
- 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/chat_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/chat_media_participant.rb +53 -1
- data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb +53 -1
- data/lib/purecloudplatformclientv2/models/command_status_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_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_aggregation_query.rb +44 -4
- data/lib/purecloudplatformclientv2/models/conversation_call_event_topic_call_media_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/conversation_callback_event_topic_callback_media_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/conversation_chat_event_topic_chat_media_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/conversation_cobrowse_event_topic_cobrowse_media_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/conversation_deletion_protection_query.rb +209 -0
- data/lib/purecloudplatformclientv2/models/conversation_email_event_topic_email_media_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/conversation_message_event_topic_message_media_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/conversation_screen_share_event_topic_screen_share_media_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/conversation_social_expression_event_topic_social_media_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/conversation_video_event_topic_video_media_participant.rb +51 -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/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/dialer_responseset_config_change_response_set.rb +26 -1
- 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/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/domain_logical_interface.rb +79 -1
- 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/email_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/email_media_participant.rb +53 -1
- 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_aggregation_query.rb +2 -2
- 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/evaluation_question.rb +13 -13
- 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/fax_document_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_aggregation_query.rb +44 -4
- data/lib/purecloudplatformclientv2/models/flow_division_view.rb +53 -1
- 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/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/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_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_create_definition.rb +405 -0
- data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/{location_create_update_definition.rb → location_update_definition.rb} +8 -28
- 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_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/{user_external_identifier.rb → message_evaluation.rb} +44 -32
- data/lib/purecloudplatformclientv2/models/message_media_participant.rb +53 -1
- 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/note_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +12 -12
- 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/participant.rb +56 -4
- data/lib/purecloudplatformclientv2/models/participant_basic.rb +56 -4
- 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_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/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_call_event_topic_call_media_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_callback_event_topic_callback_media_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_chat_event_topic_chat_media_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_cobrowse_event_topic_cobrowse_media_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_email_event_topic_email_media_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_message_event_topic_message_media_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_screen_share_event_topic_screen_share_media_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_participant.rb +51 -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/queue_user_event_topic_queue_member.rb +31 -31
- data/lib/purecloudplatformclientv2/models/queue_user_event_topic_user_reference.rb +201 -0
- 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_job_request.rb +32 -4
- data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +29 -1
- 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_schema_extension.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_service_provider_config.rb +6 -6
- data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +12 -12
- 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/selected_columns.rb +228 -0
- 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.rb +29 -1
- data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +12 -12
- 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/subscription_overview_usage.rb +56 -4
- data/lib/purecloudplatformclientv2/models/survey_aggregation_query.rb +44 -4
- 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/user_action_category_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_aggregation_query.rb +44 -4
- 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_skill_entity_listing.rb +12 -12
- 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/web_chat_message_entity_list.rb +13 -13
- data/lib/purecloudplatformclientv2/models/wfm_move_agents_complete_topic_wfm_move_agent_data.rb +2 -2
- 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 +14 -6
- data/docs/UserExternalIdentifier.md +0 -15
data/docs/TrunkEntityListing.md
CHANGED
|
@@ -11,8 +11,8 @@ title: TrunkEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
18
|
| **previous_uri** | **String** | | [optional] |
|
|
@@ -11,8 +11,8 @@ title: TrunkMetabaseEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
18
|
| **previous_uri** | **String** | | [optional] |
|
data/docs/TrustEntityListing.md
CHANGED
|
@@ -11,8 +11,8 @@ title: TrustEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
18
|
| **previous_uri** | **String** | | [optional] |
|
|
@@ -11,8 +11,8 @@ title: TrustUserEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
18
|
| **previous_uri** | **String** | | [optional] |
|
|
@@ -11,8 +11,8 @@ title: TrustorEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
18
|
| **previous_uri** | **String** | | [optional] |
|
|
@@ -11,8 +11,8 @@ title: TtsEngineEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
18
|
| **previous_uri** | **String** | | [optional] |
|
|
@@ -11,8 +11,8 @@ title: TtsVoiceEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
18
|
| **previous_uri** | **String** | | [optional] |
|
|
@@ -11,8 +11,8 @@ title: TwitterIntegrationEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
18
|
| **previous_uri** | **String** | | [optional] |
|
|
@@ -11,8 +11,8 @@ title: UserActionCategoryEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
18
|
| **previous_uri** | **String** | | [optional] |
|
|
@@ -15,6 +15,7 @@ title: UserAggregationQuery
|
|
|
15
15
|
| **metrics** | **Array<String>** | Behaves like a SQL SELECT clause. Enables retrieving only named metrics. If omitted, all metrics that are available will be returned (like SELECT *). | [optional] |
|
|
16
16
|
| **flatten_multivalued_dimensions** | **BOOLEAN** | Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c') | [optional] |
|
|
17
17
|
| **views** | [**Array<UserAggregationView>**](UserAggregationView.html) | Custom derived metric views | [optional] |
|
|
18
|
+
| **alternate_time_dimension** | **String** | Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event. | [optional] |
|
|
18
19
|
{: class="table table-striped"}
|
|
19
20
|
|
|
20
21
|
|
data/docs/UserEntityListing.md
CHANGED
|
@@ -11,8 +11,8 @@ title: UserEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
18
|
| **previous_uri** | **String** | | [optional] |
|
|
@@ -11,8 +11,8 @@ title: UserLanguageEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
18
|
| **previous_uri** | **String** | | [optional] |
|
|
@@ -11,8 +11,8 @@ title: UserProfileEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
18
|
| **previous_uri** | **String** | | [optional] |
|
|
@@ -11,8 +11,8 @@ title: UserQueueEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
18
|
| **previous_uri** | **String** | | [optional] |
|
|
@@ -11,8 +11,8 @@ title: UserRecordingEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
18
|
| **previous_uri** | **String** | | [optional] |
|
|
@@ -11,8 +11,8 @@ title: UserSkillEntityListing
|
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
18
|
| **previous_uri** | **String** | | [optional] |
|
data/docs/UsersApi.md
CHANGED
|
@@ -10,7 +10,6 @@ Method | Description
|
|
|
10
10
|
------------- | ------------- | -------------
|
|
11
11
|
[**delete_authorization_subject_division_role**](UsersApi.html#delete_authorization_subject_division_role) | Delete a grant of a role in a division
|
|
12
12
|
[**delete_user**](UsersApi.html#delete_user) | Delete user
|
|
13
|
-
[**delete_user_externalid_authority_name_external_key**](UsersApi.html#delete_user_externalid_authority_name_external_key) | Delete the external identifier for user.
|
|
14
13
|
[**delete_user_roles**](UsersApi.html#delete_user_roles) | Removes all the roles from the user.
|
|
15
14
|
[**delete_user_routinglanguage**](UsersApi.html#delete_user_routinglanguage) | Remove routing language from user
|
|
16
15
|
[**delete_user_routingskill**](UsersApi.html#delete_user_routingskill) | Remove routing skill from user
|
|
@@ -26,8 +25,6 @@ Method | Description
|
|
|
26
25
|
[**get_user_adjacents**](UsersApi.html#get_user_adjacents) | Get adjacents
|
|
27
26
|
[**get_user_callforwarding**](UsersApi.html#get_user_callforwarding) | Get a user's CallForwarding
|
|
28
27
|
[**get_user_directreports**](UsersApi.html#get_user_directreports) | Get direct reports
|
|
29
|
-
[**get_user_externalid**](UsersApi.html#get_user_externalid) | Get the external identifiers for a user.
|
|
30
|
-
[**get_user_externalid_authority_name**](UsersApi.html#get_user_externalid_authority_name) | Get the external identifier of user for an authority.
|
|
31
28
|
[**get_user_favorites**](UsersApi.html#get_user_favorites) | Get favorites
|
|
32
29
|
[**get_user_geolocation**](UsersApi.html#get_user_geolocation) | Get a user's Geolocation
|
|
33
30
|
[**get_user_outofoffice**](UsersApi.html#get_user_outofoffice) | Get a OutOfOffice
|
|
@@ -42,7 +39,6 @@ Method | Description
|
|
|
42
39
|
[**get_user_superiors**](UsersApi.html#get_user_superiors) | Get superiors
|
|
43
40
|
[**get_user_trustors**](UsersApi.html#get_user_trustors) | List the organizations that have authorized/trusted the user.
|
|
44
41
|
[**get_users**](UsersApi.html#get_users) | Get the list of available users.
|
|
45
|
-
[**get_users_externalid_authority_name_external_key**](UsersApi.html#get_users_externalid_authority_name_external_key) | Get the user associated with external identifier.
|
|
46
42
|
[**get_users_me**](UsersApi.html#get_users_me) | Get current user details.
|
|
47
43
|
[**get_users_search**](UsersApi.html#get_users_search) | Search users using the q64 value returned from a previous search
|
|
48
44
|
[**patch_user**](UsersApi.html#patch_user) | Update user
|
|
@@ -60,7 +56,6 @@ Method | Description
|
|
|
60
56
|
[**post_authorization_subject_bulkadd**](UsersApi.html#post_authorization_subject_bulkadd) | Bulk-grant roles and divisions to a subject.
|
|
61
57
|
[**post_authorization_subject_bulkremove**](UsersApi.html#post_authorization_subject_bulkremove) | Bulk-remove grants from a subject.
|
|
62
58
|
[**post_authorization_subject_division_role**](UsersApi.html#post_authorization_subject_division_role) | Make a grant of a role in a division
|
|
63
|
-
[**post_user_externalid**](UsersApi.html#post_user_externalid) | Create mapping between external identifier and user. Limit 100 per entity.
|
|
64
59
|
[**post_user_invite**](UsersApi.html#post_user_invite) | Send an activation email to the user
|
|
65
60
|
[**post_user_password**](UsersApi.html#post_user_password) | Change a users password
|
|
66
61
|
[**post_user_routinglanguages**](UsersApi.html#post_user_routinglanguages) | Add routing language to user
|
|
@@ -214,76 +209,6 @@ Name | Type | Description | Notes
|
|
|
214
209
|
|
|
215
210
|
|
|
216
211
|
|
|
217
|
-
<a name="delete_user_externalid_authority_name_external_key"></a>
|
|
218
|
-
|
|
219
|
-
## delete_user_externalid_authority_name_external_key(user_id, authority_name, external_key)
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
Delete the external identifier for user.
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
Wraps DELETE /api/v2/users/{userId}/externalid/{authorityName}/{externalKey}
|
|
228
|
-
|
|
229
|
-
Requires ANY permissions:
|
|
230
|
-
|
|
231
|
-
* directory:user:edit
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
### Example
|
|
235
|
-
```{"language":"ruby"}
|
|
236
|
-
# load the gem
|
|
237
|
-
require 'purecloudplatformclientv2'
|
|
238
|
-
# setup authorization
|
|
239
|
-
@secret = ENV['PURECLOUD_SECRET']
|
|
240
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
241
|
-
environment = "mypurecloud.com"
|
|
242
|
-
|
|
243
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
244
|
-
|
|
245
|
-
PureCloud.configure do |config|
|
|
246
|
-
config.access_token = @authToken
|
|
247
|
-
end
|
|
248
|
-
|
|
249
|
-
api_instance = PureCloud::UsersApi.new
|
|
250
|
-
|
|
251
|
-
user_id = "user_id_example" # String | User ID
|
|
252
|
-
|
|
253
|
-
authority_name = "authority_name_example" # String | Authority Name
|
|
254
|
-
|
|
255
|
-
external_key = "external_key_example" # String | External Key
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
begin
|
|
259
|
-
#Delete the external identifier for user.
|
|
260
|
-
api_instance.delete_user_externalid_authority_name_external_key(user_id, authority_name, external_key)
|
|
261
|
-
rescue PureCloud::ApiError => e
|
|
262
|
-
puts "Exception when calling UsersApi->delete_user_externalid_authority_name_external_key: #{e}"
|
|
263
|
-
end
|
|
264
|
-
```
|
|
265
|
-
|
|
266
|
-
### Parameters
|
|
267
|
-
|
|
268
|
-
Name | Type | Description | Notes
|
|
269
|
-
------------- | ------------- | ------------- | -------------
|
|
270
|
-
**user_id** | **String**| User ID | |
|
|
271
|
-
**authority_name** | **String**| Authority Name | |
|
|
272
|
-
**external_key** | **String**| External Key | |
|
|
273
|
-
{: class="table table-striped"}
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
### Return type
|
|
277
|
-
|
|
278
|
-
nil (empty response body)
|
|
279
|
-
|
|
280
|
-
### HTTP request headers
|
|
281
|
-
|
|
282
|
-
- **Content-Type**: application/json
|
|
283
|
-
- **Accept**: application/json
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
212
|
<a name="delete_user_roles"></a>
|
|
288
213
|
|
|
289
214
|
## delete_user_roles(user_id)
|
|
@@ -1282,137 +1207,6 @@ Name | Type | Description | Notes
|
|
|
1282
1207
|
|
|
1283
1208
|
|
|
1284
1209
|
|
|
1285
|
-
<a name="get_user_externalid"></a>
|
|
1286
|
-
|
|
1287
|
-
## [**Array<UserExternalIdentifier>**](UserExternalIdentifier.html) get_user_externalid(user_id)
|
|
1288
|
-
|
|
1289
|
-
|
|
1290
|
-
|
|
1291
|
-
Get the external identifiers for a user.
|
|
1292
|
-
|
|
1293
|
-
|
|
1294
|
-
|
|
1295
|
-
Wraps GET /api/v2/users/{userId}/externalid
|
|
1296
|
-
|
|
1297
|
-
Requires NO permissions:
|
|
1298
|
-
|
|
1299
|
-
|
|
1300
|
-
|
|
1301
|
-
### Example
|
|
1302
|
-
```{"language":"ruby"}
|
|
1303
|
-
# load the gem
|
|
1304
|
-
require 'purecloudplatformclientv2'
|
|
1305
|
-
# setup authorization
|
|
1306
|
-
@secret = ENV['PURECLOUD_SECRET']
|
|
1307
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1308
|
-
environment = "mypurecloud.com"
|
|
1309
|
-
|
|
1310
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1311
|
-
|
|
1312
|
-
PureCloud.configure do |config|
|
|
1313
|
-
config.access_token = @authToken
|
|
1314
|
-
end
|
|
1315
|
-
|
|
1316
|
-
api_instance = PureCloud::UsersApi.new
|
|
1317
|
-
|
|
1318
|
-
user_id = "user_id_example" # String | User ID
|
|
1319
|
-
|
|
1320
|
-
|
|
1321
|
-
begin
|
|
1322
|
-
#Get the external identifiers for a user.
|
|
1323
|
-
result = api_instance.get_user_externalid(user_id)
|
|
1324
|
-
p result
|
|
1325
|
-
rescue PureCloud::ApiError => e
|
|
1326
|
-
puts "Exception when calling UsersApi->get_user_externalid: #{e}"
|
|
1327
|
-
end
|
|
1328
|
-
```
|
|
1329
|
-
|
|
1330
|
-
### Parameters
|
|
1331
|
-
|
|
1332
|
-
Name | Type | Description | Notes
|
|
1333
|
-
------------- | ------------- | ------------- | -------------
|
|
1334
|
-
**user_id** | **String**| User ID | |
|
|
1335
|
-
{: class="table table-striped"}
|
|
1336
|
-
|
|
1337
|
-
|
|
1338
|
-
### Return type
|
|
1339
|
-
|
|
1340
|
-
[**Array<UserExternalIdentifier>**](UserExternalIdentifier.html)
|
|
1341
|
-
|
|
1342
|
-
### HTTP request headers
|
|
1343
|
-
|
|
1344
|
-
- **Content-Type**: application/json
|
|
1345
|
-
- **Accept**: application/json
|
|
1346
|
-
|
|
1347
|
-
|
|
1348
|
-
|
|
1349
|
-
<a name="get_user_externalid_authority_name"></a>
|
|
1350
|
-
|
|
1351
|
-
## [**UserExternalIdentifier**](UserExternalIdentifier.html) get_user_externalid_authority_name(user_id, authority_name)
|
|
1352
|
-
|
|
1353
|
-
|
|
1354
|
-
|
|
1355
|
-
Get the external identifier of user for an authority.
|
|
1356
|
-
|
|
1357
|
-
Authority name and external key are case sensitive.
|
|
1358
|
-
|
|
1359
|
-
Wraps GET /api/v2/users/{userId}/externalid/{authorityName}
|
|
1360
|
-
|
|
1361
|
-
Requires NO permissions:
|
|
1362
|
-
|
|
1363
|
-
|
|
1364
|
-
|
|
1365
|
-
### Example
|
|
1366
|
-
```{"language":"ruby"}
|
|
1367
|
-
# load the gem
|
|
1368
|
-
require 'purecloudplatformclientv2'
|
|
1369
|
-
# setup authorization
|
|
1370
|
-
@secret = ENV['PURECLOUD_SECRET']
|
|
1371
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1372
|
-
environment = "mypurecloud.com"
|
|
1373
|
-
|
|
1374
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1375
|
-
|
|
1376
|
-
PureCloud.configure do |config|
|
|
1377
|
-
config.access_token = @authToken
|
|
1378
|
-
end
|
|
1379
|
-
|
|
1380
|
-
api_instance = PureCloud::UsersApi.new
|
|
1381
|
-
|
|
1382
|
-
user_id = "user_id_example" # String | User ID
|
|
1383
|
-
|
|
1384
|
-
authority_name = "authority_name_example" # String | Authority Name
|
|
1385
|
-
|
|
1386
|
-
|
|
1387
|
-
begin
|
|
1388
|
-
#Get the external identifier of user for an authority.
|
|
1389
|
-
result = api_instance.get_user_externalid_authority_name(user_id, authority_name)
|
|
1390
|
-
p result
|
|
1391
|
-
rescue PureCloud::ApiError => e
|
|
1392
|
-
puts "Exception when calling UsersApi->get_user_externalid_authority_name: #{e}"
|
|
1393
|
-
end
|
|
1394
|
-
```
|
|
1395
|
-
|
|
1396
|
-
### Parameters
|
|
1397
|
-
|
|
1398
|
-
Name | Type | Description | Notes
|
|
1399
|
-
------------- | ------------- | ------------- | -------------
|
|
1400
|
-
**user_id** | **String**| User ID | |
|
|
1401
|
-
**authority_name** | **String**| Authority Name | |
|
|
1402
|
-
{: class="table table-striped"}
|
|
1403
|
-
|
|
1404
|
-
|
|
1405
|
-
### Return type
|
|
1406
|
-
|
|
1407
|
-
[**UserExternalIdentifier**](UserExternalIdentifier.html)
|
|
1408
|
-
|
|
1409
|
-
### HTTP request headers
|
|
1410
|
-
|
|
1411
|
-
- **Content-Type**: application/json
|
|
1412
|
-
- **Accept**: application/json
|
|
1413
|
-
|
|
1414
|
-
|
|
1415
|
-
|
|
1416
1210
|
<a name="get_user_favorites"></a>
|
|
1417
1211
|
|
|
1418
1212
|
## [**UserEntityListing**](UserEntityListing.html) get_user_favorites(user_id, opts)
|
|
@@ -2380,77 +2174,6 @@ Name | Type | Description | Notes
|
|
|
2380
2174
|
|
|
2381
2175
|
|
|
2382
2176
|
|
|
2383
|
-
<a name="get_users_externalid_authority_name_external_key"></a>
|
|
2384
|
-
|
|
2385
|
-
## [**User**](User.html) get_users_externalid_authority_name_external_key(authority_name, external_key, opts)
|
|
2386
|
-
|
|
2387
|
-
|
|
2388
|
-
|
|
2389
|
-
Get the user associated with external identifier.
|
|
2390
|
-
|
|
2391
|
-
Authority name and external key are case sensitive.
|
|
2392
|
-
|
|
2393
|
-
Wraps GET /api/v2/users/externalid/{authorityName}/{externalKey}
|
|
2394
|
-
|
|
2395
|
-
Requires NO permissions:
|
|
2396
|
-
|
|
2397
|
-
|
|
2398
|
-
|
|
2399
|
-
### Example
|
|
2400
|
-
```{"language":"ruby"}
|
|
2401
|
-
# load the gem
|
|
2402
|
-
require 'purecloudplatformclientv2'
|
|
2403
|
-
# setup authorization
|
|
2404
|
-
@secret = ENV['PURECLOUD_SECRET']
|
|
2405
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2406
|
-
environment = "mypurecloud.com"
|
|
2407
|
-
|
|
2408
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2409
|
-
|
|
2410
|
-
PureCloud.configure do |config|
|
|
2411
|
-
config.access_token = @authToken
|
|
2412
|
-
end
|
|
2413
|
-
|
|
2414
|
-
api_instance = PureCloud::UsersApi.new
|
|
2415
|
-
|
|
2416
|
-
authority_name = "authority_name_example" # String | Authority Name
|
|
2417
|
-
|
|
2418
|
-
external_key = "external_key_example" # String | External Key
|
|
2419
|
-
|
|
2420
|
-
opts = {
|
|
2421
|
-
expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
|
|
2422
|
-
}
|
|
2423
|
-
|
|
2424
|
-
begin
|
|
2425
|
-
#Get the user associated with external identifier.
|
|
2426
|
-
result = api_instance.get_users_externalid_authority_name_external_key(authority_name, external_key, opts)
|
|
2427
|
-
p result
|
|
2428
|
-
rescue PureCloud::ApiError => e
|
|
2429
|
-
puts "Exception when calling UsersApi->get_users_externalid_authority_name_external_key: #{e}"
|
|
2430
|
-
end
|
|
2431
|
-
```
|
|
2432
|
-
|
|
2433
|
-
### Parameters
|
|
2434
|
-
|
|
2435
|
-
Name | Type | Description | Notes
|
|
2436
|
-
------------- | ------------- | ------------- | -------------
|
|
2437
|
-
**authority_name** | **String**| Authority Name | |
|
|
2438
|
-
**external_key** | **String**| External Key | |
|
|
2439
|
-
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, authorization.unusedRoles, profileSkills, certifications, locations, groups, skills, languages, languagePreference, employerInfo, biography |
|
|
2440
|
-
{: class="table table-striped"}
|
|
2441
|
-
|
|
2442
|
-
|
|
2443
|
-
### Return type
|
|
2444
|
-
|
|
2445
|
-
[**User**](User.html)
|
|
2446
|
-
|
|
2447
|
-
### HTTP request headers
|
|
2448
|
-
|
|
2449
|
-
- **Content-Type**: application/json
|
|
2450
|
-
- **Accept**: application/json
|
|
2451
|
-
|
|
2452
|
-
|
|
2453
|
-
|
|
2454
2177
|
<a name="get_users_me"></a>
|
|
2455
2178
|
|
|
2456
2179
|
## [**UserMe**](UserMe.html) get_users_me(opts)
|
|
@@ -3614,74 +3337,6 @@ nil (empty response body)
|
|
|
3614
3337
|
|
|
3615
3338
|
|
|
3616
3339
|
|
|
3617
|
-
<a name="post_user_externalid"></a>
|
|
3618
|
-
|
|
3619
|
-
## [**Array<UserExternalIdentifier>**](UserExternalIdentifier.html) post_user_externalid(user_id, body)
|
|
3620
|
-
|
|
3621
|
-
|
|
3622
|
-
|
|
3623
|
-
Create mapping between external identifier and user. Limit 100 per entity.
|
|
3624
|
-
|
|
3625
|
-
Authority Name and External key are case sensitive.
|
|
3626
|
-
|
|
3627
|
-
Wraps POST /api/v2/users/{userId}/externalid
|
|
3628
|
-
|
|
3629
|
-
Requires ANY permissions:
|
|
3630
|
-
|
|
3631
|
-
* directory:user:edit
|
|
3632
|
-
|
|
3633
|
-
|
|
3634
|
-
### Example
|
|
3635
|
-
```{"language":"ruby"}
|
|
3636
|
-
# load the gem
|
|
3637
|
-
require 'purecloudplatformclientv2'
|
|
3638
|
-
# setup authorization
|
|
3639
|
-
@secret = ENV['PURECLOUD_SECRET']
|
|
3640
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
3641
|
-
environment = "mypurecloud.com"
|
|
3642
|
-
|
|
3643
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
3644
|
-
|
|
3645
|
-
PureCloud.configure do |config|
|
|
3646
|
-
config.access_token = @authToken
|
|
3647
|
-
end
|
|
3648
|
-
|
|
3649
|
-
api_instance = PureCloud::UsersApi.new
|
|
3650
|
-
|
|
3651
|
-
user_id = "user_id_example" # String | User ID
|
|
3652
|
-
|
|
3653
|
-
body = PureCloud::UserExternalIdentifier.new # UserExternalIdentifier |
|
|
3654
|
-
|
|
3655
|
-
|
|
3656
|
-
begin
|
|
3657
|
-
#Create mapping between external identifier and user. Limit 100 per entity.
|
|
3658
|
-
result = api_instance.post_user_externalid(user_id, body)
|
|
3659
|
-
p result
|
|
3660
|
-
rescue PureCloud::ApiError => e
|
|
3661
|
-
puts "Exception when calling UsersApi->post_user_externalid: #{e}"
|
|
3662
|
-
end
|
|
3663
|
-
```
|
|
3664
|
-
|
|
3665
|
-
### Parameters
|
|
3666
|
-
|
|
3667
|
-
Name | Type | Description | Notes
|
|
3668
|
-
------------- | ------------- | ------------- | -------------
|
|
3669
|
-
**user_id** | **String**| User ID | |
|
|
3670
|
-
**body** | [**UserExternalIdentifier**](UserExternalIdentifier.html)| | |
|
|
3671
|
-
{: class="table table-striped"}
|
|
3672
|
-
|
|
3673
|
-
|
|
3674
|
-
### Return type
|
|
3675
|
-
|
|
3676
|
-
[**Array<UserExternalIdentifier>**](UserExternalIdentifier.html)
|
|
3677
|
-
|
|
3678
|
-
### HTTP request headers
|
|
3679
|
-
|
|
3680
|
-
- **Content-Type**: application/json
|
|
3681
|
-
- **Accept**: application/json
|
|
3682
|
-
|
|
3683
|
-
|
|
3684
|
-
|
|
3685
3340
|
<a name="post_user_invite"></a>
|
|
3686
3341
|
|
|
3687
3342
|
## post_user_invite(user_id, opts)
|