purecloudplatformclientv2 57.0.0 → 58.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/docs/ADFS.md +1 -1
- data/docs/ActionEntityListing.md +1 -1
- data/docs/Agent.md +2 -1
- data/docs/AgentActivityEntityListing.md +1 -1
- data/docs/AnalyticsConversationSegment.md +1 -0
- data/docs/AnalyticsScoredAgent.md +14 -0
- data/docs/AnalyticsSession.md +1 -0
- data/docs/ArchitectApi.md +4 -2
- data/docs/ArrayNode.md +9 -9
- data/docs/AttemptLimitsEntityListing.md +1 -1
- data/docs/AuthorizationApi.md +1 -11
- data/docs/AuthzDivisionEntityListing.md +1 -1
- data/docs/{AddressableEntityUser.md → BusinessUnitReference.md} +2 -2
- data/docs/CalibrationEntityListing.md +1 -1
- data/docs/CallConversationEntityListing.md +1 -1
- data/docs/CallHistoryConversationEntityListing.md +1 -1
- data/docs/CallMediaParticipant.md +1 -0
- data/docs/CallableTimeSetEntityListing.md +1 -1
- data/docs/CallbackConversationEntityListing.md +1 -1
- data/docs/CallbackMediaParticipant.md +1 -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 +1 -0
- data/docs/ChatMessage.md +2 -0
- data/docs/ClientAppEntityListing.md +1 -1
- data/docs/CobrowseConversationEntityListing.md +1 -1
- data/docs/CobrowseMediaParticipant.md +1 -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/ConversationEntityListing.md +1 -1
- data/docs/ConversationRoutingData.md +17 -0
- data/docs/CredentialInfoListing.md +1 -1
- data/docs/CredentialTypeListing.md +1 -1
- data/docs/CustomerInteractionCenter.md +1 -1
- data/docs/DIDEntityListing.md +1 -1
- data/docs/DIDPoolEntityListing.md +1 -1
- data/docs/DataSchema.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/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/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 +1 -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/FlowDiagnosticInfo.md +13 -0
- data/docs/FlowDivisionViewEntityListing.md +1 -1
- data/docs/FlowEntityListing.md +1 -1
- data/docs/FlowVersionEntityListing.md +1 -1
- data/docs/GDPRRequestEntityListing.md +1 -1
- data/docs/GDPRSubjectEntityListing.md +1 -1
- data/docs/GSuite.md +1 -1
- data/docs/GreetingListing.md +1 -1
- data/docs/GroupEntityListing.md +1 -1
- data/docs/GroupProfileEntityListing.md +1 -1
- data/docs/GroupsApi.md +0 -6
- data/docs/IVREntityListing.md +1 -1
- data/docs/IdentityNow.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/JsonNode.md +9 -9
- data/docs/KeywordSetEntityListing.md +1 -1
- data/docs/LanguageEntityListing.md +1 -1
- data/docs/LibraryEntityListing.md +1 -1
- data/docs/LicenseApi.md +1 -78
- data/docs/LineBaseEntityListing.md +1 -1
- data/docs/LineEntityListing.md +1 -1
- data/docs/LineIntegrationEntityListing.md +1 -1
- data/docs/LocationDefinition.md +1 -0
- data/docs/LocationEntityListing.md +1 -1
- data/docs/LocationUpdateDefinition.md +1 -0
- data/docs/LogicalInterfaceEntityListing.md +1 -1
- data/docs/ManagementUnit.md +1 -0
- data/docs/ManagementUnitListing.md +1 -1
- data/docs/Manager.md +1 -0
- data/docs/MessageConversationEntityListing.md +1 -1
- data/docs/MessageMediaParticipant.md +1 -0
- 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/ObjectsApi.md +1 -1
- data/docs/ObservationValue.md +1 -0
- data/docs/Okta.md +1 -1
- data/docs/OneLogin.md +1 -1
- data/docs/OrganizationApi.md +3 -3
- data/docs/OrganizationAuthorizationApi.md +1 -9
- 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 +1 -0
- data/docs/ParticipantBasic.md +1 -0
- 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/PingIdentity.md +1 -1
- data/docs/PolicyEntityListing.md +1 -1
- data/docs/PresenceApi.md +1 -1
- data/docs/PromptAssetEntityListing.md +1 -1
- data/docs/PromptEntityListing.md +1 -1
- data/docs/PureEngage.md +1 -1
- data/docs/QualityAuditPage.md +1 -1
- data/docs/QueueEntityListing.md +1 -1
- data/docs/QueueMemberEntityListing.md +1 -1
- data/docs/RecipientListing.md +1 -1
- data/docs/Recording.md +2 -0
- 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/ResponseEntityList.md +1 -1
- data/docs/ResponseEntityListing.md +1 -1
- data/docs/ResponseSetEntityListing.md +1 -1
- data/docs/RoutingApi.md +0 -9
- data/docs/RuleSetEntityListing.md +1 -1
- data/docs/Salesforce.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/ScimV2CreateUser.md +1 -0
- data/docs/ScimV2User.md +1 -0
- data/docs/ScoredAgent.md +14 -0
- data/docs/ScreenRecordingSessionListing.md +1 -1
- data/docs/ScriptEntityListing.md +1 -1
- data/docs/ScriptsApi.md +2 -5
- data/docs/SecurityProfileEntityListing.md +1 -1
- data/docs/ShareEntityListing.md +1 -1
- data/docs/SiteEntityListing.md +1 -1
- data/docs/Skill.md +14 -0
- data/docs/SkillEntityListing.md +1 -1
- data/docs/SmsPhoneNumberEntityListing.md +1 -1
- data/docs/StationEntityListing.md +1 -1
- data/docs/SubjectDivisionGrantsEntityListing.md +1 -1
- data/docs/Survey.md +1 -0
- data/docs/SurveyErrorDetails.md +14 -0
- data/docs/SurveyFormEntityListing.md +1 -1
- data/docs/SystemMessageSystemMessage.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/TimeOffRequestNotification.md +18 -0
- data/docs/TimeZoneEntityListing.md +1 -1
- data/docs/Trunk.md +9 -0
- 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/TwitterIntegrationEntityListing.md +1 -1
- data/docs/UserActionCategoryEntityListing.md +1 -1
- data/docs/UserEntityListing.md +1 -1
- data/docs/UserExternalIdentifier.md +15 -0
- 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 +345 -25
- data/docs/VoicemailApi.md +0 -4
- data/docs/VoicemailMessageEntityListing.md +1 -1
- data/docs/WebChatMemberInfoEntityList.md +1 -1
- data/docs/WfmAbandonRate.md +2 -2
- data/docs/WfmAverageSpeedOfAnswer.md +1 -1
- data/docs/WfmServiceLevel.md +3 -3
- data/docs/WfmUserNotification.md +1 -0
- data/docs/WorkforceManagementApi.md +22 -3
- data/docs/WorkspaceEntityListing.md +1 -1
- data/docs/WorkspaceMemberEntityListing.md +1 -1
- data/docs/WrapupCodeEntityListing.md +1 -1
- data/lib/purecloudplatformclientv2.rb +9 -2
- data/lib/purecloudplatformclientv2/api/architect_api.rb +13 -0
- data/lib/purecloudplatformclientv2/api/authorization_api.rb +2 -2
- data/lib/purecloudplatformclientv2/api/license_api.rb +0 -55
- data/lib/purecloudplatformclientv2/api/objects_api.rb +2 -2
- data/lib/purecloudplatformclientv2/api/scripts_api.rb +4 -14
- data/lib/purecloudplatformclientv2/api/users_api.rb +383 -0
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +29 -2
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/adfs.rb +12 -12
- data/lib/purecloudplatformclientv2/models/agent.rb +32 -8
- data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/analytics_conversation_segment.rb +28 -1
- data/lib/purecloudplatformclientv2/models/analytics_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/analytics_scored_agent.rb +228 -0
- data/lib/purecloudplatformclientv2/models/analytics_session.rb +30 -4
- data/lib/purecloudplatformclientv2/models/array_node.rb +70 -70
- data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/authz_division_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/{addressable_entity_user.rb → business_unit_reference.rb} +1 -1
- data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/call_media_participant.rb +27 -1
- data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/callback_media_participant.rb +27 -1
- data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/chat_media_participant.rb +27 -1
- data/lib/purecloudplatformclientv2/models/chat_message.rb +53 -1
- data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb +27 -1
- data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/contact_list_division_view_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/contact_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/conversation_routing_data.rb +310 -0
- data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/customer_interaction_center.rb +12 -12
- data/lib/purecloudplatformclientv2/models/data_schema.rb +1 -1
- data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/dnc_list_division_view_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +14 -14
- data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/email_media_participant.rb +27 -1
- data/lib/purecloudplatformclientv2/models/email_message_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/evaluation_question.rb +13 -13
- data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/facebook_integration_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/flow_diagnostic_info.rb +202 -0
- data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/g_suite.rb +12 -12
- data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/greeting_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/identity_now.rb +12 -12
- data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +14 -14
- data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +14 -14
- data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/json_node.rb +70 -70
- data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/line_integration_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/location_definition.rb +26 -1
- data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/location_update_definition.rb +29 -4
- data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/management_unit.rb +27 -1
- data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/manager.rb +27 -1
- data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/message_media_participant.rb +27 -1
- data/lib/purecloudplatformclientv2/models/messaging_sticker_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/note_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/observation_value.rb +31 -4
- data/lib/purecloudplatformclientv2/models/okta.rb +12 -12
- data/lib/purecloudplatformclientv2/models/one_login.rb +12 -12
- data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/participant.rb +27 -1
- data/lib/purecloudplatformclientv2/models/participant_basic.rb +27 -1
- data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/phone_capabilities.rb +31 -4
- data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/ping_identity.rb +12 -12
- data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/pure_engage.rb +12 -12
- data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +14 -14
- data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/recipient_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/recording.rb +53 -1
- data/lib/purecloudplatformclientv2/models/relationship_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +2 -2
- data/lib/purecloudplatformclientv2/models/response_entity_list.rb +14 -14
- data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/salesforce.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/scim_v2_create_user.rb +27 -1
- data/lib/purecloudplatformclientv2/models/scim_v2_user.rb +27 -1
- data/lib/purecloudplatformclientv2/models/scored_agent.rb +228 -0
- data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/{license_organization.rb → skill.rb} +2 -56
- data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/subject_division_grants_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/survey.rb +27 -1
- data/lib/purecloudplatformclientv2/models/survey_error_details.rb +228 -0
- data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/system_message_system_message.rb +4 -6
- data/lib/purecloudplatformclientv2/models/system_prompt_asset.rb +2 -2
- data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/text_message_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/time_off_request_notification.rb +350 -0
- data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trunk.rb +269 -1
- data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/twitter_integration_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_external_identifier.rb +265 -0
- data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/web_chat_member_info_entity_list.rb +14 -14
- data/lib/purecloudplatformclientv2/models/wfm_abandon_rate.rb +3 -3
- data/lib/purecloudplatformclientv2/models/wfm_average_speed_of_answer.rb +2 -2
- data/lib/purecloudplatformclientv2/models/wfm_service_level.rb +4 -4
- data/lib/purecloudplatformclientv2/models/wfm_user_notification.rb +29 -3
- data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +20 -6
- data/docs/LicenseOrganization.md +0 -16
data/docs/SiteEntityListing.md
CHANGED
|
@@ -13,9 +13,9 @@ title: SiteEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/Skill.md
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Skill
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::Skill
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **id** | **String** | | [optional] |
|
|
11
|
+
| **self_uri** | **String** | | [optional] |
|
|
12
|
+
{: class="table table-striped"}
|
|
13
|
+
|
|
14
|
+
|
data/docs/SkillEntityListing.md
CHANGED
|
@@ -13,9 +13,9 @@ title: SkillEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ title: SmsPhoneNumberEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ title: StationEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ title: SubjectDivisionGrantsEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/Survey.md
CHANGED
|
@@ -16,6 +16,7 @@ title: Survey
|
|
|
16
16
|
| **queue** | [**QueueReference**](QueueReference.html) | | [optional] |
|
|
17
17
|
| **answers** | [**SurveyScoringSet**](SurveyScoringSet.html) | | [optional] |
|
|
18
18
|
| **completed_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
19
|
+
| **survey_error_details** | [**SurveyErrorDetails**](SurveyErrorDetails.html) | Additional information about what happened when the survey is in Error status. | [optional] |
|
|
19
20
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
20
21
|
{: class="table table-striped"}
|
|
21
22
|
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: SurveyErrorDetails
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::SurveyErrorDetails
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **flow_diagnostic_info** | [**FlowDiagnosticInfo**](FlowDiagnosticInfo.html) | Additional information about any errors that occurred in the survey invite flow. | [optional] |
|
|
11
|
+
| **survey_error_reason** | **String** | An error code indicating the reason for the survey failure. | [optional] |
|
|
12
|
+
{: class="table table-striped"}
|
|
13
|
+
|
|
14
|
+
|
|
@@ -13,9 +13,9 @@ title: SurveyFormEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -15,7 +15,7 @@ title: SystemMessageSystemMessage
|
|
|
15
15
|
| **oauth_client_id** | **String** | | [optional] |
|
|
16
16
|
| **reason** | **String** | | [optional] |
|
|
17
17
|
| **message** | **String** | | [optional] |
|
|
18
|
-
| **data** | **
|
|
18
|
+
| **data** | **Object** | | [optional] |
|
|
19
19
|
{: class="table table-striped"}
|
|
20
20
|
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ title: SystemPromptAssetEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ title: SystemPromptEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ title: TagValueEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/TextMessageListing.md
CHANGED
|
@@ -13,9 +13,9 @@ title: TextMessageListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: TimeOffRequestNotification
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::TimeOffRequestNotification
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **time_off_request_id** | **String** | The ID of this time off request | [optional] |
|
|
11
|
+
| **user** | [**UserReference**](UserReference.html) | The user associated with this time off request | [optional] |
|
|
12
|
+
| **is_full_day_request** | **BOOLEAN** | Whether this is a full day request (false means partial day) | [optional] |
|
|
13
|
+
| **status** | **String** | The status of this time off request | [optional] |
|
|
14
|
+
| **partial_day_start_date_times** | **Array<DateTime>** | A set of start date-times in ISO-8601 format for partial day requests. Will be not empty if isFullDayRequest == false | [optional] |
|
|
15
|
+
| **full_day_management_unit_dates** | **Array<String>** | A set of dates in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone. Will be not empty if isFullDayRequest == true | [optional] |
|
|
16
|
+
{: class="table table-striped"}
|
|
17
|
+
|
|
18
|
+
|
|
@@ -13,9 +13,9 @@ title: TimeZoneEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/Trunk.md
CHANGED
|
@@ -25,6 +25,15 @@ title: Trunk
|
|
|
25
25
|
| **edge_group** | [**UriReference**](UriReference.html) | The edge group associated with this trunk. | [optional] |
|
|
26
26
|
| **in_service** | **BOOLEAN** | True if this trunk is in-service. This comes from the trunk_enabled property of the referenced trunk base. | [optional] |
|
|
27
27
|
| **enabled** | **BOOLEAN** | True if the Edge used by this trunk is in-service | [optional] |
|
|
28
|
+
| **logical_interface** | [**UriReference**](UriReference.html) | The Logical Interface on the Edge to which the trunk is assigned. | [optional] |
|
|
29
|
+
| **connected_status** | [**TrunkConnectedStatus**](TrunkConnectedStatus.html) | The connected status of the trunk | [optional] |
|
|
30
|
+
| **options_status** | [**Array<TrunkMetricsOptions>**](TrunkMetricsOptions.html) | The trunk optionsStatus | [optional] |
|
|
31
|
+
| **registers_status** | [**Array<TrunkMetricsRegisters>**](TrunkMetricsRegisters.html) | The trunk registersStatus | [optional] |
|
|
32
|
+
| **ip_status** | [**TrunkMetricsNetworkTypeIp**](TrunkMetricsNetworkTypeIp.html) | The trunk ipStatus | [optional] |
|
|
33
|
+
| **options_enabled_status** | **String** | Returns Enabled when the trunk base supports the availability interval and it has a value greater than 0. | [optional] |
|
|
34
|
+
| **registers_enabled_status** | **String** | Returns Enabled when the trunk base supports the registration interval and it has a value greater than 0. | [optional] |
|
|
35
|
+
| **family** | **Integer** | The IP Network Family of the trunk | [optional] |
|
|
36
|
+
| **proxy_address_list** | **Array<String>** | The list of proxy addresses (ports if provided) for the trunk | [optional] |
|
|
28
37
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
29
38
|
{: class="table table-striped"}
|
|
30
39
|
|
|
@@ -13,9 +13,9 @@ title: TrunkBaseEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/TrunkEntityListing.md
CHANGED
|
@@ -13,9 +13,9 @@ title: TrunkEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ title: TrunkMetabaseEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/TrustEntityListing.md
CHANGED
|
@@ -13,9 +13,9 @@ title: TrustEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ title: TrustUserEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ title: TrustorEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ title: TwitterIntegrationEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ title: UserActionCategoryEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/UserEntityListing.md
CHANGED
|
@@ -13,9 +13,9 @@ title: UserEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: UserExternalIdentifier
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::UserExternalIdentifier
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **authority_name** | **String** | Authority or System of Record which owns the External Identifier | |
|
|
11
|
+
| **external_key** | **String** | External Key | |
|
|
12
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
13
|
+
{: class="table table-striped"}
|
|
14
|
+
|
|
15
|
+
|
|
@@ -13,9 +13,9 @@ title: UserLanguageEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ title: UserProfileEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ title: UserQueueEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ title: UserRecordingEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ title: UserSkillEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/UsersApi.md
CHANGED
|
@@ -10,6 +10,7 @@ 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.
|
|
13
14
|
[**delete_user_roles**](UsersApi.html#delete_user_roles) | Removes all the roles from the user.
|
|
14
15
|
[**delete_user_routinglanguage**](UsersApi.html#delete_user_routinglanguage) | Remove routing language from user
|
|
15
16
|
[**delete_user_routingskill**](UsersApi.html#delete_user_routingskill) | Remove routing skill from user
|
|
@@ -25,6 +26,8 @@ Method | Description
|
|
|
25
26
|
[**get_user_adjacents**](UsersApi.html#get_user_adjacents) | Get adjacents
|
|
26
27
|
[**get_user_callforwarding**](UsersApi.html#get_user_callforwarding) | Get a user's CallForwarding
|
|
27
28
|
[**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.
|
|
28
31
|
[**get_user_favorites**](UsersApi.html#get_user_favorites) | Get favorites
|
|
29
32
|
[**get_user_geolocation**](UsersApi.html#get_user_geolocation) | Get a user's Geolocation
|
|
30
33
|
[**get_user_outofoffice**](UsersApi.html#get_user_outofoffice) | Get a OutOfOffice
|
|
@@ -39,6 +42,7 @@ Method | Description
|
|
|
39
42
|
[**get_user_superiors**](UsersApi.html#get_user_superiors) | Get superiors
|
|
40
43
|
[**get_user_trustors**](UsersApi.html#get_user_trustors) | List the organizations that have authorized/trusted the user.
|
|
41
44
|
[**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.
|
|
42
46
|
[**get_users_me**](UsersApi.html#get_users_me) | Get current user details.
|
|
43
47
|
[**get_users_search**](UsersApi.html#get_users_search) | Search users using the q64 value returned from a previous search
|
|
44
48
|
[**patch_user**](UsersApi.html#patch_user) | Update user
|
|
@@ -54,6 +58,7 @@ Method | Description
|
|
|
54
58
|
[**post_analytics_users_details_query**](UsersApi.html#post_analytics_users_details_query) | Query for user details
|
|
55
59
|
[**post_analytics_users_observations_query**](UsersApi.html#post_analytics_users_observations_query) | Query for user observations
|
|
56
60
|
[**post_authorization_subject_division_role**](UsersApi.html#post_authorization_subject_division_role) | Make a grant of a role in a division
|
|
61
|
+
[**post_user_externalid**](UsersApi.html#post_user_externalid) | Create mapping between external identifier and user. Limit 100 per entity.
|
|
57
62
|
[**post_user_invite**](UsersApi.html#post_user_invite) | Send an activation email to the user
|
|
58
63
|
[**post_user_password**](UsersApi.html#post_user_password) | Change a users password
|
|
59
64
|
[**post_user_routinglanguages**](UsersApi.html#post_user_routinglanguages) | Add routing language to user
|
|
@@ -157,8 +162,6 @@ Wraps DELETE /api/v2/users/{userId}
|
|
|
157
162
|
Requires ANY permissions:
|
|
158
163
|
|
|
159
164
|
* directory:user:delete
|
|
160
|
-
* user_manager
|
|
161
|
-
* user_administration
|
|
162
165
|
|
|
163
166
|
|
|
164
167
|
### Example
|
|
@@ -209,6 +212,76 @@ Name | Type | Description | Notes
|
|
|
209
212
|
|
|
210
213
|
|
|
211
214
|
|
|
215
|
+
<a name="delete_user_externalid_authority_name_external_key"></a>
|
|
216
|
+
|
|
217
|
+
## delete_user_externalid_authority_name_external_key(user_id, authority_name, external_key)
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
Delete the external identifier for user.
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
Wraps DELETE /api/v2/users/{userId}/externalid/{authorityName}/{externalKey}
|
|
226
|
+
|
|
227
|
+
Requires ANY permissions:
|
|
228
|
+
|
|
229
|
+
* directory:user:edit
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
### Example
|
|
233
|
+
```{"language":"ruby"}
|
|
234
|
+
# load the gem
|
|
235
|
+
require 'purecloudplatformclientv2'
|
|
236
|
+
# setup authorization
|
|
237
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
238
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
239
|
+
environment = "mypurecloud.com"
|
|
240
|
+
|
|
241
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
242
|
+
|
|
243
|
+
PureCloud.configure do |config|
|
|
244
|
+
config.access_token = @authToken
|
|
245
|
+
end
|
|
246
|
+
|
|
247
|
+
api_instance = PureCloud::UsersApi.new
|
|
248
|
+
|
|
249
|
+
user_id = "user_id_example" # String | User ID
|
|
250
|
+
|
|
251
|
+
authority_name = "authority_name_example" # String | Authority Name
|
|
252
|
+
|
|
253
|
+
external_key = "external_key_example" # String | External Key
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
begin
|
|
257
|
+
#Delete the external identifier for user.
|
|
258
|
+
api_instance.delete_user_externalid_authority_name_external_key(user_id, authority_name, external_key)
|
|
259
|
+
rescue PureCloud::ApiError => e
|
|
260
|
+
puts "Exception when calling UsersApi->delete_user_externalid_authority_name_external_key: #{e}"
|
|
261
|
+
end
|
|
262
|
+
```
|
|
263
|
+
|
|
264
|
+
### Parameters
|
|
265
|
+
|
|
266
|
+
Name | Type | Description | Notes
|
|
267
|
+
------------- | ------------- | ------------- | -------------
|
|
268
|
+
**user_id** | **String**| User ID | |
|
|
269
|
+
**authority_name** | **String**| Authority Name | |
|
|
270
|
+
**external_key** | **String**| External Key | |
|
|
271
|
+
{: class="table table-striped"}
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
### Return type
|
|
275
|
+
|
|
276
|
+
nil (empty response body)
|
|
277
|
+
|
|
278
|
+
### HTTP request headers
|
|
279
|
+
|
|
280
|
+
- **Content-Type**: application/json
|
|
281
|
+
- **Accept**: application/json
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
|
|
212
285
|
<a name="delete_user_roles"></a>
|
|
213
286
|
|
|
214
287
|
## delete_user_roles(user_id)
|
|
@@ -223,8 +296,6 @@ Wraps DELETE /api/v2/users/{userId}/roles
|
|
|
223
296
|
|
|
224
297
|
Requires ANY permissions:
|
|
225
298
|
|
|
226
|
-
* admin
|
|
227
|
-
* role_manager
|
|
228
299
|
* authorization:grant:delete
|
|
229
300
|
|
|
230
301
|
|
|
@@ -290,7 +361,6 @@ Wraps DELETE /api/v2/users/{userId}/routinglanguages/{languageId}
|
|
|
290
361
|
Requires ANY permissions:
|
|
291
362
|
|
|
292
363
|
* routing:skill:assign
|
|
293
|
-
* admin
|
|
294
364
|
|
|
295
365
|
|
|
296
366
|
### Example
|
|
@@ -358,7 +428,6 @@ Wraps DELETE /api/v2/users/{userId}/routingskills/{skillId}
|
|
|
358
428
|
Requires ANY permissions:
|
|
359
429
|
|
|
360
430
|
* routing:skill:assign
|
|
361
|
-
* admin
|
|
362
431
|
|
|
363
432
|
|
|
364
433
|
### Example
|
|
@@ -1212,6 +1281,137 @@ Name | Type | Description | Notes
|
|
|
1212
1281
|
|
|
1213
1282
|
|
|
1214
1283
|
|
|
1284
|
+
<a name="get_user_externalid"></a>
|
|
1285
|
+
|
|
1286
|
+
## [**Array<UserExternalIdentifier>**](UserExternalIdentifier.html) get_user_externalid(user_id)
|
|
1287
|
+
|
|
1288
|
+
|
|
1289
|
+
|
|
1290
|
+
Get the external identifiers for a user.
|
|
1291
|
+
|
|
1292
|
+
|
|
1293
|
+
|
|
1294
|
+
Wraps GET /api/v2/users/{userId}/externalid
|
|
1295
|
+
|
|
1296
|
+
Requires NO permissions:
|
|
1297
|
+
|
|
1298
|
+
|
|
1299
|
+
|
|
1300
|
+
### Example
|
|
1301
|
+
```{"language":"ruby"}
|
|
1302
|
+
# load the gem
|
|
1303
|
+
require 'purecloudplatformclientv2'
|
|
1304
|
+
# setup authorization
|
|
1305
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1306
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1307
|
+
environment = "mypurecloud.com"
|
|
1308
|
+
|
|
1309
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1310
|
+
|
|
1311
|
+
PureCloud.configure do |config|
|
|
1312
|
+
config.access_token = @authToken
|
|
1313
|
+
end
|
|
1314
|
+
|
|
1315
|
+
api_instance = PureCloud::UsersApi.new
|
|
1316
|
+
|
|
1317
|
+
user_id = "user_id_example" # String | User ID
|
|
1318
|
+
|
|
1319
|
+
|
|
1320
|
+
begin
|
|
1321
|
+
#Get the external identifiers for a user.
|
|
1322
|
+
result = api_instance.get_user_externalid(user_id)
|
|
1323
|
+
p result
|
|
1324
|
+
rescue PureCloud::ApiError => e
|
|
1325
|
+
puts "Exception when calling UsersApi->get_user_externalid: #{e}"
|
|
1326
|
+
end
|
|
1327
|
+
```
|
|
1328
|
+
|
|
1329
|
+
### Parameters
|
|
1330
|
+
|
|
1331
|
+
Name | Type | Description | Notes
|
|
1332
|
+
------------- | ------------- | ------------- | -------------
|
|
1333
|
+
**user_id** | **String**| User ID | |
|
|
1334
|
+
{: class="table table-striped"}
|
|
1335
|
+
|
|
1336
|
+
|
|
1337
|
+
### Return type
|
|
1338
|
+
|
|
1339
|
+
[**Array<UserExternalIdentifier>**](UserExternalIdentifier.html)
|
|
1340
|
+
|
|
1341
|
+
### HTTP request headers
|
|
1342
|
+
|
|
1343
|
+
- **Content-Type**: application/json
|
|
1344
|
+
- **Accept**: application/json
|
|
1345
|
+
|
|
1346
|
+
|
|
1347
|
+
|
|
1348
|
+
<a name="get_user_externalid_authority_name"></a>
|
|
1349
|
+
|
|
1350
|
+
## [**UserExternalIdentifier**](UserExternalIdentifier.html) get_user_externalid_authority_name(user_id, authority_name)
|
|
1351
|
+
|
|
1352
|
+
|
|
1353
|
+
|
|
1354
|
+
Get the external identifier of user for an authority.
|
|
1355
|
+
|
|
1356
|
+
Authority name and external key are case sensitive.
|
|
1357
|
+
|
|
1358
|
+
Wraps GET /api/v2/users/{userId}/externalid/{authorityName}
|
|
1359
|
+
|
|
1360
|
+
Requires NO permissions:
|
|
1361
|
+
|
|
1362
|
+
|
|
1363
|
+
|
|
1364
|
+
### Example
|
|
1365
|
+
```{"language":"ruby"}
|
|
1366
|
+
# load the gem
|
|
1367
|
+
require 'purecloudplatformclientv2'
|
|
1368
|
+
# setup authorization
|
|
1369
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1370
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1371
|
+
environment = "mypurecloud.com"
|
|
1372
|
+
|
|
1373
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1374
|
+
|
|
1375
|
+
PureCloud.configure do |config|
|
|
1376
|
+
config.access_token = @authToken
|
|
1377
|
+
end
|
|
1378
|
+
|
|
1379
|
+
api_instance = PureCloud::UsersApi.new
|
|
1380
|
+
|
|
1381
|
+
user_id = "user_id_example" # String | User ID
|
|
1382
|
+
|
|
1383
|
+
authority_name = "authority_name_example" # String | Authority Name
|
|
1384
|
+
|
|
1385
|
+
|
|
1386
|
+
begin
|
|
1387
|
+
#Get the external identifier of user for an authority.
|
|
1388
|
+
result = api_instance.get_user_externalid_authority_name(user_id, authority_name)
|
|
1389
|
+
p result
|
|
1390
|
+
rescue PureCloud::ApiError => e
|
|
1391
|
+
puts "Exception when calling UsersApi->get_user_externalid_authority_name: #{e}"
|
|
1392
|
+
end
|
|
1393
|
+
```
|
|
1394
|
+
|
|
1395
|
+
### Parameters
|
|
1396
|
+
|
|
1397
|
+
Name | Type | Description | Notes
|
|
1398
|
+
------------- | ------------- | ------------- | -------------
|
|
1399
|
+
**user_id** | **String**| User ID | |
|
|
1400
|
+
**authority_name** | **String**| Authority Name | |
|
|
1401
|
+
{: class="table table-striped"}
|
|
1402
|
+
|
|
1403
|
+
|
|
1404
|
+
### Return type
|
|
1405
|
+
|
|
1406
|
+
[**UserExternalIdentifier**](UserExternalIdentifier.html)
|
|
1407
|
+
|
|
1408
|
+
### HTTP request headers
|
|
1409
|
+
|
|
1410
|
+
- **Content-Type**: application/json
|
|
1411
|
+
- **Accept**: application/json
|
|
1412
|
+
|
|
1413
|
+
|
|
1414
|
+
|
|
1215
1415
|
<a name="get_user_favorites"></a>
|
|
1216
1416
|
|
|
1217
1417
|
## [**UserEntityListing**](UserEntityListing.html) get_user_favorites(user_id, opts)
|
|
@@ -2179,6 +2379,77 @@ Name | Type | Description | Notes
|
|
|
2179
2379
|
|
|
2180
2380
|
|
|
2181
2381
|
|
|
2382
|
+
<a name="get_users_externalid_authority_name_external_key"></a>
|
|
2383
|
+
|
|
2384
|
+
## [**User**](User.html) get_users_externalid_authority_name_external_key(authority_name, external_key, opts)
|
|
2385
|
+
|
|
2386
|
+
|
|
2387
|
+
|
|
2388
|
+
Get the user associated with external identifier.
|
|
2389
|
+
|
|
2390
|
+
Authority name and external key are case sensitive.
|
|
2391
|
+
|
|
2392
|
+
Wraps GET /api/v2/users/externalid/{authorityName}/{externalKey}
|
|
2393
|
+
|
|
2394
|
+
Requires NO permissions:
|
|
2395
|
+
|
|
2396
|
+
|
|
2397
|
+
|
|
2398
|
+
### Example
|
|
2399
|
+
```{"language":"ruby"}
|
|
2400
|
+
# load the gem
|
|
2401
|
+
require 'purecloudplatformclientv2'
|
|
2402
|
+
# setup authorization
|
|
2403
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2404
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2405
|
+
environment = "mypurecloud.com"
|
|
2406
|
+
|
|
2407
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2408
|
+
|
|
2409
|
+
PureCloud.configure do |config|
|
|
2410
|
+
config.access_token = @authToken
|
|
2411
|
+
end
|
|
2412
|
+
|
|
2413
|
+
api_instance = PureCloud::UsersApi.new
|
|
2414
|
+
|
|
2415
|
+
authority_name = "authority_name_example" # String | Authority Name
|
|
2416
|
+
|
|
2417
|
+
external_key = "external_key_example" # String | External Key
|
|
2418
|
+
|
|
2419
|
+
opts = {
|
|
2420
|
+
expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
|
|
2421
|
+
}
|
|
2422
|
+
|
|
2423
|
+
begin
|
|
2424
|
+
#Get the user associated with external identifier.
|
|
2425
|
+
result = api_instance.get_users_externalid_authority_name_external_key(authority_name, external_key, opts)
|
|
2426
|
+
p result
|
|
2427
|
+
rescue PureCloud::ApiError => e
|
|
2428
|
+
puts "Exception when calling UsersApi->get_users_externalid_authority_name_external_key: #{e}"
|
|
2429
|
+
end
|
|
2430
|
+
```
|
|
2431
|
+
|
|
2432
|
+
### Parameters
|
|
2433
|
+
|
|
2434
|
+
Name | Type | Description | Notes
|
|
2435
|
+
------------- | ------------- | ------------- | -------------
|
|
2436
|
+
**authority_name** | **String**| Authority Name | |
|
|
2437
|
+
**external_key** | **String**| External Key | |
|
|
2438
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, certifications, locations, groups, skills, languages, languagePreference, employerInfo, biography |
|
|
2439
|
+
{: class="table table-striped"}
|
|
2440
|
+
|
|
2441
|
+
|
|
2442
|
+
### Return type
|
|
2443
|
+
|
|
2444
|
+
[**User**](User.html)
|
|
2445
|
+
|
|
2446
|
+
### HTTP request headers
|
|
2447
|
+
|
|
2448
|
+
- **Content-Type**: application/json
|
|
2449
|
+
- **Accept**: application/json
|
|
2450
|
+
|
|
2451
|
+
|
|
2452
|
+
|
|
2182
2453
|
<a name="get_users_me"></a>
|
|
2183
2454
|
|
|
2184
2455
|
## [**UserMe**](UserMe.html) get_users_me(opts)
|
|
@@ -2327,8 +2598,6 @@ Wraps PATCH /api/v2/users/{userId}
|
|
|
2327
2598
|
Requires ANY permissions:
|
|
2328
2599
|
|
|
2329
2600
|
* directory:user:edit
|
|
2330
|
-
* user_manager
|
|
2331
|
-
* user_administration
|
|
2332
2601
|
|
|
2333
2602
|
|
|
2334
2603
|
### Example
|
|
@@ -2677,7 +2946,6 @@ Wraps PATCH /api/v2/users/{userId}/routinglanguages/{languageId}
|
|
|
2677
2946
|
Requires ANY permissions:
|
|
2678
2947
|
|
|
2679
2948
|
* routing:skill:assign
|
|
2680
|
-
* admin
|
|
2681
2949
|
|
|
2682
2950
|
|
|
2683
2951
|
### Example
|
|
@@ -2749,7 +3017,6 @@ Wraps PATCH /api/v2/users/{userId}/routinglanguages/bulk
|
|
|
2749
3017
|
Requires ANY permissions:
|
|
2750
3018
|
|
|
2751
3019
|
* routing:skill:assign
|
|
2752
|
-
* admin
|
|
2753
3020
|
|
|
2754
3021
|
|
|
2755
3022
|
### Example
|
|
@@ -2818,7 +3085,6 @@ Wraps PATCH /api/v2/users/{userId}/routingskills/bulk
|
|
|
2818
3085
|
Requires ANY permissions:
|
|
2819
3086
|
|
|
2820
3087
|
* routing:skill:assign
|
|
2821
|
-
* admin
|
|
2822
3088
|
|
|
2823
3089
|
|
|
2824
3090
|
### Example
|
|
@@ -2887,8 +3153,6 @@ Wraps PATCH /api/v2/users/bulk
|
|
|
2887
3153
|
Requires ANY permissions:
|
|
2888
3154
|
|
|
2889
3155
|
* directory:user:add
|
|
2890
|
-
* user_manager
|
|
2891
|
-
* user_administration
|
|
2892
3156
|
* directory:user:edit
|
|
2893
3157
|
|
|
2894
3158
|
|
|
@@ -3209,6 +3473,74 @@ nil (empty response body)
|
|
|
3209
3473
|
|
|
3210
3474
|
|
|
3211
3475
|
|
|
3476
|
+
<a name="post_user_externalid"></a>
|
|
3477
|
+
|
|
3478
|
+
## [**Array<UserExternalIdentifier>**](UserExternalIdentifier.html) post_user_externalid(user_id, body)
|
|
3479
|
+
|
|
3480
|
+
|
|
3481
|
+
|
|
3482
|
+
Create mapping between external identifier and user. Limit 100 per entity.
|
|
3483
|
+
|
|
3484
|
+
Authority Name and External key are case sensitive.
|
|
3485
|
+
|
|
3486
|
+
Wraps POST /api/v2/users/{userId}/externalid
|
|
3487
|
+
|
|
3488
|
+
Requires ANY permissions:
|
|
3489
|
+
|
|
3490
|
+
* directory:user:edit
|
|
3491
|
+
|
|
3492
|
+
|
|
3493
|
+
### Example
|
|
3494
|
+
```{"language":"ruby"}
|
|
3495
|
+
# load the gem
|
|
3496
|
+
require 'purecloudplatformclientv2'
|
|
3497
|
+
# setup authorization
|
|
3498
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
3499
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
3500
|
+
environment = "mypurecloud.com"
|
|
3501
|
+
|
|
3502
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
3503
|
+
|
|
3504
|
+
PureCloud.configure do |config|
|
|
3505
|
+
config.access_token = @authToken
|
|
3506
|
+
end
|
|
3507
|
+
|
|
3508
|
+
api_instance = PureCloud::UsersApi.new
|
|
3509
|
+
|
|
3510
|
+
user_id = "user_id_example" # String | User ID
|
|
3511
|
+
|
|
3512
|
+
body = PureCloud::UserExternalIdentifier.new # UserExternalIdentifier |
|
|
3513
|
+
|
|
3514
|
+
|
|
3515
|
+
begin
|
|
3516
|
+
#Create mapping between external identifier and user. Limit 100 per entity.
|
|
3517
|
+
result = api_instance.post_user_externalid(user_id, body)
|
|
3518
|
+
p result
|
|
3519
|
+
rescue PureCloud::ApiError => e
|
|
3520
|
+
puts "Exception when calling UsersApi->post_user_externalid: #{e}"
|
|
3521
|
+
end
|
|
3522
|
+
```
|
|
3523
|
+
|
|
3524
|
+
### Parameters
|
|
3525
|
+
|
|
3526
|
+
Name | Type | Description | Notes
|
|
3527
|
+
------------- | ------------- | ------------- | -------------
|
|
3528
|
+
**user_id** | **String**| User ID | |
|
|
3529
|
+
**body** | [**UserExternalIdentifier**](UserExternalIdentifier.html)| | |
|
|
3530
|
+
{: class="table table-striped"}
|
|
3531
|
+
|
|
3532
|
+
|
|
3533
|
+
### Return type
|
|
3534
|
+
|
|
3535
|
+
[**Array<UserExternalIdentifier>**](UserExternalIdentifier.html)
|
|
3536
|
+
|
|
3537
|
+
### HTTP request headers
|
|
3538
|
+
|
|
3539
|
+
- **Content-Type**: application/json
|
|
3540
|
+
- **Accept**: application/json
|
|
3541
|
+
|
|
3542
|
+
|
|
3543
|
+
|
|
3212
3544
|
<a name="post_user_invite"></a>
|
|
3213
3545
|
|
|
3214
3546
|
## post_user_invite(user_id, opts)
|
|
@@ -3224,8 +3556,6 @@ Wraps POST /api/v2/users/{userId}/invite
|
|
|
3224
3556
|
Requires ANY permissions:
|
|
3225
3557
|
|
|
3226
3558
|
* directory:user:add
|
|
3227
|
-
* user_manager
|
|
3228
|
-
* user_administration
|
|
3229
3559
|
|
|
3230
3560
|
|
|
3231
3561
|
### Example
|
|
@@ -3293,7 +3623,6 @@ Wraps POST /api/v2/users/{userId}/password
|
|
|
3293
3623
|
|
|
3294
3624
|
Requires ANY permissions:
|
|
3295
3625
|
|
|
3296
|
-
* user_administration
|
|
3297
3626
|
* directory:user:setPassword
|
|
3298
3627
|
|
|
3299
3628
|
|
|
@@ -3362,7 +3691,6 @@ Wraps POST /api/v2/users/{userId}/routinglanguages
|
|
|
3362
3691
|
Requires ANY permissions:
|
|
3363
3692
|
|
|
3364
3693
|
* routing:skill:assign
|
|
3365
|
-
* admin
|
|
3366
3694
|
|
|
3367
3695
|
|
|
3368
3696
|
### Example
|
|
@@ -3431,7 +3759,6 @@ Wraps POST /api/v2/users/{userId}/routingskills
|
|
|
3431
3759
|
Requires ANY permissions:
|
|
3432
3760
|
|
|
3433
3761
|
* routing:skill:assign
|
|
3434
|
-
* admin
|
|
3435
3762
|
|
|
3436
3763
|
|
|
3437
3764
|
### Example
|
|
@@ -3826,9 +4153,6 @@ Wraps PUT /api/v2/users/{userId}/profileskills
|
|
|
3826
4153
|
Requires ANY permissions:
|
|
3827
4154
|
|
|
3828
4155
|
* directory:userProfile:edit
|
|
3829
|
-
* admin
|
|
3830
|
-
* user_manager
|
|
3831
|
-
* user_administration
|
|
3832
4156
|
|
|
3833
4157
|
|
|
3834
4158
|
### Example
|
|
@@ -3896,8 +4220,6 @@ Wraps PUT /api/v2/users/{userId}/roles
|
|
|
3896
4220
|
|
|
3897
4221
|
Requires ANY permissions:
|
|
3898
4222
|
|
|
3899
|
-
* admin
|
|
3900
|
-
* role_manager
|
|
3901
4223
|
* authorization:grant:add
|
|
3902
4224
|
|
|
3903
4225
|
|
|
@@ -3967,7 +4289,6 @@ Wraps PUT /api/v2/users/{userId}/routingskills/{skillId}
|
|
|
3967
4289
|
Requires ANY permissions:
|
|
3968
4290
|
|
|
3969
4291
|
* routing:skill:assign
|
|
3970
|
-
* admin
|
|
3971
4292
|
|
|
3972
4293
|
|
|
3973
4294
|
### Example
|
|
@@ -4039,7 +4360,6 @@ Wraps PUT /api/v2/users/{userId}/routingskills/bulk
|
|
|
4039
4360
|
Requires ANY permissions:
|
|
4040
4361
|
|
|
4041
4362
|
* routing:skill:assign
|
|
4042
|
-
* admin
|
|
4043
4363
|
|
|
4044
4364
|
|
|
4045
4365
|
### Example
|