purecloudplatformclientv2 64.0.1 → 69.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/ActionEntityListing.md +1 -1
- data/docs/AgentActivityEntityListing.md +1 -1
- data/docs/AnalyticsEvaluation.md +2 -0
- data/docs/ArchitectApi.md +21 -86
- data/docs/ArchitectDependencyTrackingBuildNotificationClient.md +14 -0
- data/docs/ArchitectDependencyTrackingBuildNotificationDependencyTrackingBuildNotification.md +1 -0
- data/docs/ArchitectFlowNotificationArchitectOperation.md +1 -0
- data/docs/ArchitectFlowNotificationClient.md +14 -0
- data/docs/ArchitectFlowOutcomeNotificationArchitectOperation.md +1 -0
- data/docs/ArchitectFlowOutcomeNotificationClient.md +14 -0
- data/docs/ArchitectPromptNotificationArchitectOperation.md +1 -0
- data/docs/ArchitectPromptNotificationClient.md +14 -0
- data/docs/AsyncConversationQuery.md +1 -0
- data/docs/AttemptLimitsEntityListing.md +1 -1
- data/docs/AuthorizationApi.md +140 -0
- data/docs/AuthzDivisionEntityListing.md +1 -1
- data/docs/CalibrationEntityListing.md +1 -1
- data/docs/CallConversation.md +1 -0
- 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/ConversationCallEventTopicCallConversation.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/CreateWorkPlan.md +11 -0
- data/docs/CreateWorkPlanActivity.md +2 -0
- data/docs/CreateWorkPlanShift.md +7 -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/EvaluationAggregationQuery.md +1 -0
- 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/HomerRecord.md +63 -0
- 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/IntegrationType.md +1 -0
- data/docs/IntegrationTypeEntityListing.md +1 -1
- data/docs/InteractionStatsAlertContainer.md +1 -1
- data/docs/InteractionStatsRuleContainer.md +1 -1
- data/docs/IpAddressRange.md +15 -0
- data/docs/IpAddressRangeListing.md +13 -0
- data/docs/KeywordSetEntityListing.md +1 -1
- data/docs/LanguageEntityListing.md +1 -1
- data/docs/LexBotAliasEntityListing.md +1 -1
- data/docs/LexBotEntityListing.md +1 -1
- data/docs/LibraryEntityListing.md +1 -1
- data/docs/LineBaseEntityListing.md +1 -1
- data/docs/LineEntityListing.md +1 -1
- data/docs/LineIntegrationEntityListing.md +1 -1
- data/docs/LocationAddressVerificationDetails.md +16 -0
- data/docs/LocationCreateDefinition.md +20 -0
- data/docs/LocationDefinition.md +12 -9
- data/docs/LocationEntityListing.md +1 -1
- data/docs/LocationUpdateDefinition.md +20 -0
- data/docs/LocationsApi.md +6 -6
- data/docs/LogicalInterfaceEntityListing.md +1 -1
- data/docs/ManagementUnitListing.md +1 -1
- data/docs/Manager.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/NotificationsApi.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/PlanningPeriodSettings.md +14 -0
- 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/QueueConversationCallEventTopicCallConversation.md +1 -0
- 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/Recording.md +1 -0
- data/docs/RecordingApi.md +164 -14
- data/docs/RecordingJobEntityListing.md +1 -1
- data/docs/RecordingJobsQuery.md +1 -1
- data/docs/RecordingMetadata.md +1 -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/ReportingExportJobRequest.md +2 -0
- data/docs/ReportingExportJobResponse.md +2 -0
- data/docs/ResponseEntityList.md +1 -1
- data/docs/ResponseEntityListing.md +1 -1
- data/docs/ResponseSetEntityListing.md +1 -1
- data/docs/RoleDivisionGrants.md +13 -0
- data/docs/RoleDivisionPair.md +14 -0
- data/docs/RoutingApi.md +0 -2
- data/docs/RuleSetEntityListing.md +1 -1
- data/docs/SCIMApi.md +88 -96
- data/docs/SIPSearchPublicRequest.md +22 -0
- data/docs/ScheduleEntityListing.md +1 -1
- data/docs/ScheduleGroupEntityListing.md +1 -1
- data/docs/SchedulingSettings.md +1 -0
- data/docs/SchemaCategoryEntityListing.md +1 -1
- data/docs/SchemaReferenceEntityListing.md +1 -1
- data/docs/ScimConfigResourceType.md +7 -7
- data/docs/ScimConfigResourceTypeSchemaExtension.md +2 -2
- data/docs/ScimConfigResourceTypesListResponse.md +2 -2
- data/docs/ScimGroupListResponse.md +2 -2
- data/docs/ScimMetadata.md +2 -2
- data/docs/ScimPhoneNumber.md +1 -1
- data/docs/ScimServiceProviderConfig.md +9 -9
- data/docs/ScimServiceProviderConfigAuthenticationScheme.md +6 -6
- data/docs/ScimServiceProviderConfigBulkFeature.md +3 -3
- data/docs/ScimServiceProviderConfigFilterFeature.md +2 -2
- data/docs/ScimServiceProviderConfigSimpleFeature.md +1 -1
- data/docs/ScimUserListResponse.md +2 -2
- data/docs/ScimV2CreateUser.md +9 -9
- data/docs/ScimV2Group.md +3 -3
- data/docs/ScimV2GroupReference.md +2 -2
- data/docs/ScimV2MemberReference.md +2 -2
- data/docs/ScimV2PatchOperation.md +2 -2
- data/docs/ScimV2PatchRequest.md +2 -2
- data/docs/ScimV2User.md +10 -10
- data/docs/ScreenRecordingSessionListing.md +1 -1
- data/docs/ScriptEntityListing.md +1 -1
- data/docs/SearchApi.md +3 -3
- data/docs/SecurityProfileEntityListing.md +1 -1
- data/docs/SelectedColumns.md +14 -0
- data/docs/ShareEntityListing.md +1 -1
- data/docs/SignedUrlResponse.md +16 -0
- data/docs/SipDownloadResponse.md +14 -0
- data/docs/SipSearchResult.md +20 -0
- data/docs/Site.md +1 -0
- 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/SuggestApi.md +2 -2
- 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/TelephonyApi.md +223 -0
- data/docs/TextMessageListing.md +1 -1
- data/docs/TimeOffRequestLookup.md +13 -0
- 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/TrusteeBillingOverview.md +1 -0
- 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/UserDetailsQuery.md +2 -2
- 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 +101 -306
- data/docs/UtilitiesApi.md +59 -0
- data/docs/VoicemailMessageEntityListing.md +1 -1
- data/docs/WebChatMemberInfoEntityList.md +1 -1
- data/docs/WebChatMessageEntityList.md +1 -1
- data/docs/WfmForecastModificationIntervalOffsetValue.md +1 -1
- data/docs/WhatsAppIntegrationEntityListing.md +1 -1
- data/docs/WorkPlan.md +11 -0
- data/docs/WorkPlanActivity.md +2 -0
- data/docs/WorkPlanListItemResponse.md +11 -0
- data/docs/WorkPlanShift.md +7 -0
- data/docs/WorkspaceEntityListing.md +1 -1
- data/docs/WorkspaceMemberEntityListing.md +1 -1
- data/docs/WrapupCodeEntityListing.md +1 -1
- data/lib/purecloudplatformclientv2.rb +22 -3
- data/lib/purecloudplatformclientv2/api/architect_api.rb +24 -81
- data/lib/purecloudplatformclientv2/api/authorization_api.rb +157 -0
- data/lib/purecloudplatformclientv2/api/notifications_api.rb +2 -2
- 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/scim_api.rb +134 -84
- data/lib/purecloudplatformclientv2/api/telephony_api.rb +270 -0
- data/lib/purecloudplatformclientv2/api/users_api.rb +127 -353
- data/lib/purecloudplatformclientv2/api/utilities_api.rb +55 -0
- 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/analytics_evaluation.rb +53 -1
- data/lib/purecloudplatformclientv2/models/analytics_flow.rb +2 -2
- data/lib/purecloudplatformclientv2/models/architect_dependency_tracking_build_notification_client.rb +226 -0
- data/lib/purecloudplatformclientv2/models/architect_dependency_tracking_build_notification_dependency_tracking_build_notification.rb +26 -1
- data/lib/purecloudplatformclientv2/models/architect_flow_notification_architect_operation.rb +26 -1
- data/lib/purecloudplatformclientv2/models/architect_flow_notification_client.rb +226 -0
- data/lib/purecloudplatformclientv2/models/architect_flow_outcome_notification_architect_operation.rb +26 -1
- data/lib/purecloudplatformclientv2/models/architect_flow_outcome_notification_client.rb +226 -0
- data/lib/purecloudplatformclientv2/models/architect_prompt_notification_architect_operation.rb +26 -1
- data/lib/purecloudplatformclientv2/models/architect_prompt_notification_client.rb +226 -0
- data/lib/purecloudplatformclientv2/models/async_conversation_query.rb +30 -4
- 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.rb +27 -1
- 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_aggregation_view.rb +2 -2
- data/lib/purecloudplatformclientv2/models/conversation_call_event_topic_call_conversation.rb +29 -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/create_work_plan.rb +301 -1
- data/lib/purecloudplatformclientv2/models/create_work_plan_activity.rb +56 -4
- data/lib/purecloudplatformclientv2/models/create_work_plan_shift.rb +211 -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.rb +2 -2
- data/lib/purecloudplatformclientv2/models/dependency_object.rb +2 -2
- 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_aggregate_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/evaluation_aggregation_query.rb +44 -4
- data/lib/purecloudplatformclientv2/models/evaluation_aggregation_view.rb +2 -2
- data/lib/purecloudplatformclientv2/models/evaluation_detail_query_predicate.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/event_message.rb +2 -2
- 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.rb +2 -2
- data/lib/purecloudplatformclientv2/models/flow_aggregate_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/flow_aggregation_query.rb +44 -4
- data/lib/purecloudplatformclientv2/models/flow_division_view.rb +55 -3
- 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/homer_record.rb +1501 -0
- 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.rb +29 -1
- 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/ip_address_range.rb +265 -0
- data/lib/purecloudplatformclientv2/models/ip_address_range_listing.rb +203 -0
- 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_address_verification_details.rb +294 -0
- data/lib/purecloudplatformclientv2/models/location_create_definition.rb +405 -0
- data/lib/purecloudplatformclientv2/models/location_definition.rb +110 -34
- data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/{location_create_update_definition.rb → location_update_definition.rb} +48 -63
- 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/manager.rb +1 -1
- data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/message_evaluation.rb +277 -0
- 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/planning_period_settings.rb +238 -0
- 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_conversation.rb +29 -4
- 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.rb +27 -1
- data/lib/purecloudplatformclientv2/models/recording_job_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/recording_jobs_query.rb +1 -1
- data/lib/purecloudplatformclientv2/models/recording_metadata.rb +27 -1
- 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_data_export_topic_data_export_notification.rb +2 -2
- data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/reporting_export_job_request.rb +60 -6
- data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +57 -3
- 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/role_division_grants.rb +209 -0
- data/lib/purecloudplatformclientv2/models/role_division_pair.rb +238 -0
- 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/scheduling_settings.rb +30 -4
- data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/scim_config_resource_type.rb +7 -7
- data/lib/purecloudplatformclientv2/models/scim_config_resource_type_schema_extension.rb +3 -3
- data/lib/purecloudplatformclientv2/models/scim_config_resource_types_list_response.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_group_list_response.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_metadata.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_phone_number.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_service_provider_config.rb +9 -9
- data/lib/purecloudplatformclientv2/models/scim_service_provider_config_authentication_scheme.rb +7 -7
- data/lib/purecloudplatformclientv2/models/scim_service_provider_config_bulk_feature.rb +4 -4
- data/lib/purecloudplatformclientv2/models/scim_service_provider_config_filter_feature.rb +3 -3
- data/lib/purecloudplatformclientv2/models/scim_service_provider_config_simple_feature.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_user_list_response.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_v2_create_user.rb +9 -8
- data/lib/purecloudplatformclientv2/models/scim_v2_group.rb +3 -3
- data/lib/purecloudplatformclientv2/models/scim_v2_group_reference.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_v2_member_reference.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_v2_patch_operation.rb +3 -3
- data/lib/purecloudplatformclientv2/models/scim_v2_patch_request.rb +2 -1
- data/lib/purecloudplatformclientv2/models/scim_v2_user.rb +10 -9
- 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/{user_external_identifier.rb → signed_url_response.rb} +39 -25
- data/lib/purecloudplatformclientv2/models/sip_download_response.rb +228 -0
- data/lib/purecloudplatformclientv2/models/{data_table_import_job.rb → sip_search_public_request.rb} +57 -133
- data/lib/purecloudplatformclientv2/models/sip_search_result.rb +386 -0
- data/lib/purecloudplatformclientv2/models/site.rb +26 -1
- 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_off_request_lookup.rb +357 -1
- 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/trustee_billing_overview.rb +27 -1
- 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_details_query.rb +52 -51
- 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_forecast_modification_interval_offset_value.rb +1 -1
- 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/work_plan.rb +301 -1
- data/lib/purecloudplatformclientv2/models/work_plan_activity.rb +53 -1
- data/lib/purecloudplatformclientv2/models/work_plan_list_item_response.rb +301 -1
- data/lib/purecloudplatformclientv2/models/work_plan_shift.rb +211 -1
- data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +46 -8
- data/docs/DataTableImportJob.md +0 -24
- data/docs/LocationCreateUpdateDefinition.md +0 -21
- data/docs/UserExternalIdentifier.md +0 -15
data/docs/TextMessageListing.md
CHANGED
|
@@ -11,8 +11,8 @@ title: TextMessageListing
|
|
|
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] |
|
|
@@ -9,6 +9,19 @@ title: TimeOffRequestLookup
|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
10
|
| **id** | **String** | The id of the time off request | |
|
|
11
11
|
| **user** | [**User**](User.html) | The user that the time off request belongs to | |
|
|
12
|
+
| **is_full_day_request** | **BOOLEAN** | Whether this is a full day request (false means partial day) | [optional] |
|
|
13
|
+
| **marked_as_read** | **BOOLEAN** | Whether this request has been marked as read by the agent | [optional] |
|
|
14
|
+
| **activity_code_id** | **String** | The ID of the activity code associated with this time off request. Activity code must be of the TimeOff category | [optional] |
|
|
15
|
+
| **status** | **String** | The status of this time off request | [optional] |
|
|
16
|
+
| **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] |
|
|
17
|
+
| **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] |
|
|
18
|
+
| **daily_duration_minutes** | **Integer** | The daily duration of this time off request in minutes | [optional] |
|
|
19
|
+
| **notes** | **String** | Notes about the time off request | [optional] |
|
|
20
|
+
| **submitted_by** | [**User**](User.html) | The user who submitted this time off request | [optional] |
|
|
21
|
+
| **submitted_date** | **DateTime** | The timestamp when this request was submitted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
22
|
+
| **reviewed_by** | [**User**](User.html) | The user who reviewed this time off request | [optional] |
|
|
23
|
+
| **reviewed_date** | **DateTime** | The timestamp when this request was reviewed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
24
|
+
| **metadata** | [**WfmVersionedEntityMetadata**](WfmVersionedEntityMetadata.html) | The version metadata of the time off request | [optional] |
|
|
12
25
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
13
26
|
{: class="table table-striped"}
|
|
14
27
|
|
|
@@ -11,8 +11,8 @@ title: TimeZoneEntityListing
|
|
|
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: TrunkBaseEntityListing
|
|
|
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/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] |
|
|
@@ -21,6 +21,7 @@ title: TrusteeBillingOverview
|
|
|
21
21
|
| **contract_amendment_date** | **DateTime** | Date-time the contract was last amended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
22
22
|
| **contract_effective_date** | **DateTime** | Date-time the contract became effective. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
23
23
|
| **contract_end_date** | **DateTime** | Date-time the contract ends. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
24
|
+
| **minimum_monthly_amount** | **String** | Minimum amount that will be charged for the month | [optional] |
|
|
24
25
|
| **in_ramp_period** | **BOOLEAN** | | [optional] |
|
|
25
26
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
26
27
|
{: class="table table-striped"}
|
|
@@ -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/UserDetailsQuery.md
CHANGED
|
@@ -9,12 +9,12 @@ title: UserDetailsQuery
|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
10
|
| **interval** | **String** | Specifies the date and time range of data being queried. Conversations MUST have started within this time range to potentially be included within the result set. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | [optional] |
|
|
11
11
|
| **user_filters** | [**Array<UserDetailQueryFilter>**](UserDetailQueryFilter.html) | Filters that target the users to retrieve data for | [optional] |
|
|
12
|
+
| **presence_filters** | [**Array<PresenceDetailQueryFilter>**](PresenceDetailQueryFilter.html) | Filters that target system and organization presence-level data | [optional] |
|
|
12
13
|
| **routing_status_filters** | [**Array<RoutingStatusDetailQueryFilter>**](RoutingStatusDetailQueryFilter.html) | Filters that target agent routing status-level data | [optional] |
|
|
14
|
+
| **order** | **String** | Sort the result set in ascending/descending order. Default is ascending | [optional] |
|
|
13
15
|
| **presence_aggregations** | [**Array<AnalyticsQueryAggregation>**](AnalyticsQueryAggregation.html) | Include faceted search and aggregate roll-ups of presence data in your search results. This does not function as a filter, but rather, summary data about the presence results matching your filters | [optional] |
|
|
14
16
|
| **routing_status_aggregations** | [**Array<AnalyticsQueryAggregation>**](AnalyticsQueryAggregation.html) | Include faceted search and aggregate roll-ups of agent routing status data in your search results. This does not function as a filter, but rather, summary data about the agent routing status results matching your filters | [optional] |
|
|
15
17
|
| **paging** | [**PagingSpec**](PagingSpec.html) | Page size and number to control iterating through large result sets. Default page size is 25 | [optional] |
|
|
16
|
-
| **order** | **String** | Sort the result set in ascending/descending order. Default is ascending | [optional] |
|
|
17
|
-
| **presence_detail_filters** | [**Array<PresenceDetailQueryFilter>**](PresenceDetailQueryFilter.html) | | [optional] |
|
|
18
18
|
{: class="table table-striped"}
|
|
19
19
|
|
|
20
20
|
|
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
|
|
@@ -57,8 +53,9 @@ Method | Description
|
|
|
57
53
|
[**post_analytics_users_aggregates_query**](UsersApi.html#post_analytics_users_aggregates_query) | Query for user aggregates
|
|
58
54
|
[**post_analytics_users_details_query**](UsersApi.html#post_analytics_users_details_query) | Query for user details
|
|
59
55
|
[**post_analytics_users_observations_query**](UsersApi.html#post_analytics_users_observations_query) | Query for user observations
|
|
56
|
+
[**post_authorization_subject_bulkadd**](UsersApi.html#post_authorization_subject_bulkadd) | Bulk-grant roles and divisions to a subject.
|
|
57
|
+
[**post_authorization_subject_bulkremove**](UsersApi.html#post_authorization_subject_bulkremove) | Bulk-remove grants from a subject.
|
|
60
58
|
[**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.
|
|
62
59
|
[**post_user_invite**](UsersApi.html#post_user_invite) | Send an activation email to the user
|
|
63
60
|
[**post_user_password**](UsersApi.html#post_user_password) | Change a users password
|
|
64
61
|
[**post_user_routinglanguages**](UsersApi.html#post_user_routinglanguages) | Add routing language to user
|
|
@@ -212,76 +209,6 @@ Name | Type | Description | Notes
|
|
|
212
209
|
|
|
213
210
|
|
|
214
211
|
|
|
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
|
-
|
|
285
212
|
<a name="delete_user_roles"></a>
|
|
286
213
|
|
|
287
214
|
## delete_user_roles(user_id)
|
|
@@ -1280,137 +1207,6 @@ Name | Type | Description | Notes
|
|
|
1280
1207
|
|
|
1281
1208
|
|
|
1282
1209
|
|
|
1283
|
-
<a name="get_user_externalid"></a>
|
|
1284
|
-
|
|
1285
|
-
## [**Array<UserExternalIdentifier>**](UserExternalIdentifier.html) get_user_externalid(user_id)
|
|
1286
|
-
|
|
1287
|
-
|
|
1288
|
-
|
|
1289
|
-
Get the external identifiers for a user.
|
|
1290
|
-
|
|
1291
|
-
|
|
1292
|
-
|
|
1293
|
-
Wraps GET /api/v2/users/{userId}/externalid
|
|
1294
|
-
|
|
1295
|
-
Requires NO permissions:
|
|
1296
|
-
|
|
1297
|
-
|
|
1298
|
-
|
|
1299
|
-
### Example
|
|
1300
|
-
```{"language":"ruby"}
|
|
1301
|
-
# load the gem
|
|
1302
|
-
require 'purecloudplatformclientv2'
|
|
1303
|
-
# setup authorization
|
|
1304
|
-
@secret = ENV['PURECLOUD_SECRET']
|
|
1305
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1306
|
-
environment = "mypurecloud.com"
|
|
1307
|
-
|
|
1308
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1309
|
-
|
|
1310
|
-
PureCloud.configure do |config|
|
|
1311
|
-
config.access_token = @authToken
|
|
1312
|
-
end
|
|
1313
|
-
|
|
1314
|
-
api_instance = PureCloud::UsersApi.new
|
|
1315
|
-
|
|
1316
|
-
user_id = "user_id_example" # String | User ID
|
|
1317
|
-
|
|
1318
|
-
|
|
1319
|
-
begin
|
|
1320
|
-
#Get the external identifiers for a user.
|
|
1321
|
-
result = api_instance.get_user_externalid(user_id)
|
|
1322
|
-
p result
|
|
1323
|
-
rescue PureCloud::ApiError => e
|
|
1324
|
-
puts "Exception when calling UsersApi->get_user_externalid: #{e}"
|
|
1325
|
-
end
|
|
1326
|
-
```
|
|
1327
|
-
|
|
1328
|
-
### Parameters
|
|
1329
|
-
|
|
1330
|
-
Name | Type | Description | Notes
|
|
1331
|
-
------------- | ------------- | ------------- | -------------
|
|
1332
|
-
**user_id** | **String**| User ID | |
|
|
1333
|
-
{: class="table table-striped"}
|
|
1334
|
-
|
|
1335
|
-
|
|
1336
|
-
### Return type
|
|
1337
|
-
|
|
1338
|
-
[**Array<UserExternalIdentifier>**](UserExternalIdentifier.html)
|
|
1339
|
-
|
|
1340
|
-
### HTTP request headers
|
|
1341
|
-
|
|
1342
|
-
- **Content-Type**: application/json
|
|
1343
|
-
- **Accept**: application/json
|
|
1344
|
-
|
|
1345
|
-
|
|
1346
|
-
|
|
1347
|
-
<a name="get_user_externalid_authority_name"></a>
|
|
1348
|
-
|
|
1349
|
-
## [**UserExternalIdentifier**](UserExternalIdentifier.html) get_user_externalid_authority_name(user_id, authority_name)
|
|
1350
|
-
|
|
1351
|
-
|
|
1352
|
-
|
|
1353
|
-
Get the external identifier of user for an authority.
|
|
1354
|
-
|
|
1355
|
-
Authority name and external key are case sensitive.
|
|
1356
|
-
|
|
1357
|
-
Wraps GET /api/v2/users/{userId}/externalid/{authorityName}
|
|
1358
|
-
|
|
1359
|
-
Requires NO permissions:
|
|
1360
|
-
|
|
1361
|
-
|
|
1362
|
-
|
|
1363
|
-
### Example
|
|
1364
|
-
```{"language":"ruby"}
|
|
1365
|
-
# load the gem
|
|
1366
|
-
require 'purecloudplatformclientv2'
|
|
1367
|
-
# setup authorization
|
|
1368
|
-
@secret = ENV['PURECLOUD_SECRET']
|
|
1369
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1370
|
-
environment = "mypurecloud.com"
|
|
1371
|
-
|
|
1372
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1373
|
-
|
|
1374
|
-
PureCloud.configure do |config|
|
|
1375
|
-
config.access_token = @authToken
|
|
1376
|
-
end
|
|
1377
|
-
|
|
1378
|
-
api_instance = PureCloud::UsersApi.new
|
|
1379
|
-
|
|
1380
|
-
user_id = "user_id_example" # String | User ID
|
|
1381
|
-
|
|
1382
|
-
authority_name = "authority_name_example" # String | Authority Name
|
|
1383
|
-
|
|
1384
|
-
|
|
1385
|
-
begin
|
|
1386
|
-
#Get the external identifier of user for an authority.
|
|
1387
|
-
result = api_instance.get_user_externalid_authority_name(user_id, authority_name)
|
|
1388
|
-
p result
|
|
1389
|
-
rescue PureCloud::ApiError => e
|
|
1390
|
-
puts "Exception when calling UsersApi->get_user_externalid_authority_name: #{e}"
|
|
1391
|
-
end
|
|
1392
|
-
```
|
|
1393
|
-
|
|
1394
|
-
### Parameters
|
|
1395
|
-
|
|
1396
|
-
Name | Type | Description | Notes
|
|
1397
|
-
------------- | ------------- | ------------- | -------------
|
|
1398
|
-
**user_id** | **String**| User ID | |
|
|
1399
|
-
**authority_name** | **String**| Authority Name | |
|
|
1400
|
-
{: class="table table-striped"}
|
|
1401
|
-
|
|
1402
|
-
|
|
1403
|
-
### Return type
|
|
1404
|
-
|
|
1405
|
-
[**UserExternalIdentifier**](UserExternalIdentifier.html)
|
|
1406
|
-
|
|
1407
|
-
### HTTP request headers
|
|
1408
|
-
|
|
1409
|
-
- **Content-Type**: application/json
|
|
1410
|
-
- **Accept**: application/json
|
|
1411
|
-
|
|
1412
|
-
|
|
1413
|
-
|
|
1414
1210
|
<a name="get_user_favorites"></a>
|
|
1415
1211
|
|
|
1416
1212
|
## [**UserEntityListing**](UserEntityListing.html) get_user_favorites(user_id, opts)
|
|
@@ -2378,77 +2174,6 @@ Name | Type | Description | Notes
|
|
|
2378
2174
|
|
|
2379
2175
|
|
|
2380
2176
|
|
|
2381
|
-
<a name="get_users_externalid_authority_name_external_key"></a>
|
|
2382
|
-
|
|
2383
|
-
## [**User**](User.html) get_users_externalid_authority_name_external_key(authority_name, external_key, opts)
|
|
2384
|
-
|
|
2385
|
-
|
|
2386
|
-
|
|
2387
|
-
Get the user associated with external identifier.
|
|
2388
|
-
|
|
2389
|
-
Authority name and external key are case sensitive.
|
|
2390
|
-
|
|
2391
|
-
Wraps GET /api/v2/users/externalid/{authorityName}/{externalKey}
|
|
2392
|
-
|
|
2393
|
-
Requires NO permissions:
|
|
2394
|
-
|
|
2395
|
-
|
|
2396
|
-
|
|
2397
|
-
### Example
|
|
2398
|
-
```{"language":"ruby"}
|
|
2399
|
-
# load the gem
|
|
2400
|
-
require 'purecloudplatformclientv2'
|
|
2401
|
-
# setup authorization
|
|
2402
|
-
@secret = ENV['PURECLOUD_SECRET']
|
|
2403
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2404
|
-
environment = "mypurecloud.com"
|
|
2405
|
-
|
|
2406
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2407
|
-
|
|
2408
|
-
PureCloud.configure do |config|
|
|
2409
|
-
config.access_token = @authToken
|
|
2410
|
-
end
|
|
2411
|
-
|
|
2412
|
-
api_instance = PureCloud::UsersApi.new
|
|
2413
|
-
|
|
2414
|
-
authority_name = "authority_name_example" # String | Authority Name
|
|
2415
|
-
|
|
2416
|
-
external_key = "external_key_example" # String | External Key
|
|
2417
|
-
|
|
2418
|
-
opts = {
|
|
2419
|
-
expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
|
|
2420
|
-
}
|
|
2421
|
-
|
|
2422
|
-
begin
|
|
2423
|
-
#Get the user associated with external identifier.
|
|
2424
|
-
result = api_instance.get_users_externalid_authority_name_external_key(authority_name, external_key, opts)
|
|
2425
|
-
p result
|
|
2426
|
-
rescue PureCloud::ApiError => e
|
|
2427
|
-
puts "Exception when calling UsersApi->get_users_externalid_authority_name_external_key: #{e}"
|
|
2428
|
-
end
|
|
2429
|
-
```
|
|
2430
|
-
|
|
2431
|
-
### Parameters
|
|
2432
|
-
|
|
2433
|
-
Name | Type | Description | Notes
|
|
2434
|
-
------------- | ------------- | ------------- | -------------
|
|
2435
|
-
**authority_name** | **String**| Authority Name | |
|
|
2436
|
-
**external_key** | **String**| External Key | |
|
|
2437
|
-
**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 |
|
|
2438
|
-
{: class="table table-striped"}
|
|
2439
|
-
|
|
2440
|
-
|
|
2441
|
-
### Return type
|
|
2442
|
-
|
|
2443
|
-
[**User**](User.html)
|
|
2444
|
-
|
|
2445
|
-
### HTTP request headers
|
|
2446
|
-
|
|
2447
|
-
- **Content-Type**: application/json
|
|
2448
|
-
- **Accept**: application/json
|
|
2449
|
-
|
|
2450
|
-
|
|
2451
|
-
|
|
2452
2177
|
<a name="get_users_me"></a>
|
|
2453
2178
|
|
|
2454
2179
|
## [**UserMe**](UserMe.html) get_users_me(opts)
|
|
@@ -3400,17 +3125,17 @@ Name | Type | Description | Notes
|
|
|
3400
3125
|
|
|
3401
3126
|
|
|
3402
3127
|
|
|
3403
|
-
<a name="
|
|
3128
|
+
<a name="post_authorization_subject_bulkadd"></a>
|
|
3404
3129
|
|
|
3405
|
-
##
|
|
3130
|
+
## post_authorization_subject_bulkadd(subject_id, body, opts)
|
|
3406
3131
|
|
|
3407
3132
|
|
|
3408
3133
|
|
|
3409
|
-
|
|
3134
|
+
Bulk-grant roles and divisions to a subject.
|
|
3410
3135
|
|
|
3411
3136
|
|
|
3412
3137
|
|
|
3413
|
-
Wraps POST /api/v2/authorization/subjects/{subjectId}/
|
|
3138
|
+
Wraps POST /api/v2/authorization/subjects/{subjectId}/bulkadd
|
|
3414
3139
|
|
|
3415
3140
|
Requires ANY permissions:
|
|
3416
3141
|
|
|
@@ -3436,19 +3161,17 @@ api_instance = PureCloud::UsersApi.new
|
|
|
3436
3161
|
|
|
3437
3162
|
subject_id = "subject_id_example" # String | Subject ID (user or group)
|
|
3438
3163
|
|
|
3439
|
-
|
|
3440
|
-
|
|
3441
|
-
role_id = "role_id_example" # String | the id of the role to grant
|
|
3164
|
+
body = PureCloud::RoleDivisionGrants.new # RoleDivisionGrants | Pairs of role and division IDs
|
|
3442
3165
|
|
|
3443
3166
|
opts = {
|
|
3444
|
-
subject_type: "PC_USER" # String | what the type of the subject is
|
|
3167
|
+
subject_type: "PC_USER" # String | what the type of the subject is (PC_GROUP, PC_USER or PC_OAUTH_CLIENT)
|
|
3445
3168
|
}
|
|
3446
3169
|
|
|
3447
3170
|
begin
|
|
3448
|
-
#
|
|
3449
|
-
api_instance.
|
|
3171
|
+
#Bulk-grant roles and divisions to a subject.
|
|
3172
|
+
api_instance.post_authorization_subject_bulkadd(subject_id, body, opts)
|
|
3450
3173
|
rescue PureCloud::ApiError => e
|
|
3451
|
-
puts "Exception when calling UsersApi->
|
|
3174
|
+
puts "Exception when calling UsersApi->post_authorization_subject_bulkadd: #{e}"
|
|
3452
3175
|
end
|
|
3453
3176
|
```
|
|
3454
3177
|
|
|
@@ -3457,9 +3180,8 @@ end
|
|
|
3457
3180
|
Name | Type | Description | Notes
|
|
3458
3181
|
------------- | ------------- | ------------- | -------------
|
|
3459
3182
|
**subject_id** | **String**| Subject ID (user or group) | |
|
|
3460
|
-
**
|
|
3461
|
-
**
|
|
3462
|
-
**subject_type** | **String**| what the type of the subject is: PC_GROUP, PC_USER or PC_OAUTH_CLIENT (note: for cross-org authorization, please use the Organization Authorization endpoints) | [optional] [default to PC_USER] |
|
|
3183
|
+
**body** | [**RoleDivisionGrants**](RoleDivisionGrants.html)| Pairs of role and division IDs | |
|
|
3184
|
+
**subject_type** | **String**| what the type of the subject is (PC_GROUP, PC_USER or PC_OAUTH_CLIENT) | [optional] [default to PC_USER] |
|
|
3463
3185
|
{: class="table table-striped"}
|
|
3464
3186
|
|
|
3465
3187
|
|
|
@@ -3474,21 +3196,21 @@ nil (empty response body)
|
|
|
3474
3196
|
|
|
3475
3197
|
|
|
3476
3198
|
|
|
3477
|
-
<a name="
|
|
3199
|
+
<a name="post_authorization_subject_bulkremove"></a>
|
|
3478
3200
|
|
|
3479
|
-
##
|
|
3201
|
+
## post_authorization_subject_bulkremove(subject_id, body)
|
|
3480
3202
|
|
|
3481
3203
|
|
|
3482
3204
|
|
|
3483
|
-
|
|
3205
|
+
Bulk-remove grants from a subject.
|
|
3484
3206
|
|
|
3485
|
-
Authority Name and External key are case sensitive.
|
|
3486
3207
|
|
|
3487
|
-
|
|
3208
|
+
|
|
3209
|
+
Wraps POST /api/v2/authorization/subjects/{subjectId}/bulkremove
|
|
3488
3210
|
|
|
3489
3211
|
Requires ANY permissions:
|
|
3490
3212
|
|
|
3491
|
-
*
|
|
3213
|
+
* authorization:grant:delete
|
|
3492
3214
|
|
|
3493
3215
|
|
|
3494
3216
|
### Example
|
|
@@ -3508,17 +3230,16 @@ end
|
|
|
3508
3230
|
|
|
3509
3231
|
api_instance = PureCloud::UsersApi.new
|
|
3510
3232
|
|
|
3511
|
-
|
|
3233
|
+
subject_id = "subject_id_example" # String | Subject ID (user or group)
|
|
3512
3234
|
|
|
3513
|
-
body = PureCloud::
|
|
3235
|
+
body = PureCloud::RoleDivisionGrants.new # RoleDivisionGrants | Pairs of role and division IDs
|
|
3514
3236
|
|
|
3515
3237
|
|
|
3516
3238
|
begin
|
|
3517
|
-
#
|
|
3518
|
-
|
|
3519
|
-
p result
|
|
3239
|
+
#Bulk-remove grants from a subject.
|
|
3240
|
+
api_instance.post_authorization_subject_bulkremove(subject_id, body)
|
|
3520
3241
|
rescue PureCloud::ApiError => e
|
|
3521
|
-
puts "Exception when calling UsersApi->
|
|
3242
|
+
puts "Exception when calling UsersApi->post_authorization_subject_bulkremove: #{e}"
|
|
3522
3243
|
end
|
|
3523
3244
|
```
|
|
3524
3245
|
|
|
@@ -3526,14 +3247,88 @@ end
|
|
|
3526
3247
|
|
|
3527
3248
|
Name | Type | Description | Notes
|
|
3528
3249
|
------------- | ------------- | ------------- | -------------
|
|
3529
|
-
**
|
|
3530
|
-
**body** | [**
|
|
3250
|
+
**subject_id** | **String**| Subject ID (user or group) | |
|
|
3251
|
+
**body** | [**RoleDivisionGrants**](RoleDivisionGrants.html)| Pairs of role and division IDs | |
|
|
3531
3252
|
{: class="table table-striped"}
|
|
3532
3253
|
|
|
3533
3254
|
|
|
3534
3255
|
### Return type
|
|
3535
3256
|
|
|
3536
|
-
|
|
3257
|
+
nil (empty response body)
|
|
3258
|
+
|
|
3259
|
+
### HTTP request headers
|
|
3260
|
+
|
|
3261
|
+
- **Content-Type**: application/json
|
|
3262
|
+
- **Accept**: application/json
|
|
3263
|
+
|
|
3264
|
+
|
|
3265
|
+
|
|
3266
|
+
<a name="post_authorization_subject_division_role"></a>
|
|
3267
|
+
|
|
3268
|
+
## post_authorization_subject_division_role(subject_id, division_id, role_id, opts)
|
|
3269
|
+
|
|
3270
|
+
|
|
3271
|
+
|
|
3272
|
+
Make a grant of a role in a division
|
|
3273
|
+
|
|
3274
|
+
|
|
3275
|
+
|
|
3276
|
+
Wraps POST /api/v2/authorization/subjects/{subjectId}/divisions/{divisionId}/roles/{roleId}
|
|
3277
|
+
|
|
3278
|
+
Requires ANY permissions:
|
|
3279
|
+
|
|
3280
|
+
* authorization:grant:add
|
|
3281
|
+
|
|
3282
|
+
|
|
3283
|
+
### Example
|
|
3284
|
+
```{"language":"ruby"}
|
|
3285
|
+
# load the gem
|
|
3286
|
+
require 'purecloudplatformclientv2'
|
|
3287
|
+
# setup authorization
|
|
3288
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
3289
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
3290
|
+
environment = "mypurecloud.com"
|
|
3291
|
+
|
|
3292
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
3293
|
+
|
|
3294
|
+
PureCloud.configure do |config|
|
|
3295
|
+
config.access_token = @authToken
|
|
3296
|
+
end
|
|
3297
|
+
|
|
3298
|
+
api_instance = PureCloud::UsersApi.new
|
|
3299
|
+
|
|
3300
|
+
subject_id = "subject_id_example" # String | Subject ID (user or group)
|
|
3301
|
+
|
|
3302
|
+
division_id = "division_id_example" # String | the id of the division to which to make the grant
|
|
3303
|
+
|
|
3304
|
+
role_id = "role_id_example" # String | the id of the role to grant
|
|
3305
|
+
|
|
3306
|
+
opts = {
|
|
3307
|
+
subject_type: "PC_USER" # String | what the type of the subject is: PC_GROUP, PC_USER or PC_OAUTH_CLIENT (note: for cross-org authorization, please use the Organization Authorization endpoints)
|
|
3308
|
+
}
|
|
3309
|
+
|
|
3310
|
+
begin
|
|
3311
|
+
#Make a grant of a role in a division
|
|
3312
|
+
api_instance.post_authorization_subject_division_role(subject_id, division_id, role_id, opts)
|
|
3313
|
+
rescue PureCloud::ApiError => e
|
|
3314
|
+
puts "Exception when calling UsersApi->post_authorization_subject_division_role: #{e}"
|
|
3315
|
+
end
|
|
3316
|
+
```
|
|
3317
|
+
|
|
3318
|
+
### Parameters
|
|
3319
|
+
|
|
3320
|
+
Name | Type | Description | Notes
|
|
3321
|
+
------------- | ------------- | ------------- | -------------
|
|
3322
|
+
**subject_id** | **String**| Subject ID (user or group) | |
|
|
3323
|
+
**division_id** | **String**| the id of the division to which to make the grant | |
|
|
3324
|
+
**role_id** | **String**| the id of the role to grant | |
|
|
3325
|
+
**subject_type** | **String**| what the type of the subject is: PC_GROUP, PC_USER or PC_OAUTH_CLIENT (note: for cross-org authorization, please use the Organization Authorization endpoints) | [optional] [default to PC_USER] |
|
|
3326
|
+
{: class="table table-striped"}
|
|
3327
|
+
|
|
3328
|
+
|
|
3329
|
+
### Return type
|
|
3330
|
+
|
|
3331
|
+
nil (empty response body)
|
|
3537
3332
|
|
|
3538
3333
|
### HTTP request headers
|
|
3539
3334
|
|