purecloudplatformclientv2 66.0.0 → 71.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/AnalyticsSession.md +1 -0
- data/docs/ArchitectApi.md +21 -17
- data/docs/AttemptLimitsEntityListing.md +1 -1
- data/docs/AuthorizationApi.md +140 -0
- data/docs/AuthzDivisionEntityListing.md +1 -1
- data/docs/BuSearchAgentSchedulesRequest.md +15 -0
- data/docs/CalibrationEntityListing.md +1 -1
- data/docs/CallConversationEntityListing.md +1 -1
- data/docs/CallHistoryConversationEntityListing.md +1 -1
- data/docs/CallMediaParticipant.md +2 -0
- data/docs/CallableTimeSetEntityListing.md +1 -1
- data/docs/CallbackConversationEntityListing.md +1 -1
- data/docs/CallbackMediaParticipant.md +2 -0
- data/docs/CampaignDivisionViewListing.md +1 -1
- data/docs/CampaignEntityListing.md +1 -1
- data/docs/CampaignRuleEntityListing.md +1 -1
- data/docs/CampaignSequenceEntityListing.md +1 -1
- data/docs/CertificateAuthorityEntityListing.md +1 -1
- data/docs/ChatConversationEntityListing.md +1 -1
- data/docs/ChatMediaParticipant.md +2 -0
- data/docs/ClientAppEntityListing.md +1 -1
- data/docs/CobrowseConversationEntityListing.md +1 -1
- data/docs/CobrowseMediaParticipant.md +2 -0
- data/docs/CommandStatusEntityListing.md +1 -1
- data/docs/ConsumedResourcesEntityListing.md +1 -1
- data/docs/ConsumingResourcesEntityListing.md +1 -1
- data/docs/ContactCenterSettings.md +13 -0
- data/docs/ContactListDivisionViewListing.md +1 -1
- data/docs/ContactListEntityListing.md +1 -1
- data/docs/ContactListFilterEntityListing.md +1 -1
- data/docs/ContactListing.md +1 -1
- data/docs/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/ConversationsApi.md +198 -0
- data/docs/CreateManagementUnitApiRequest.md +1 -1
- data/docs/{CreateManagementUnitSettings.md → CreateManagementUnitSettingsRequest.md} +3 -3
- data/docs/CreateWorkPlan.md +1 -0
- data/docs/CreateWorkPlanShift.md +1 -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/DomainEdgeSoftwareVersionDto.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 +4 -0
- data/docs/EdgeEntityListing.md +1 -1
- data/docs/EdgeGroupEntityListing.md +1 -1
- data/docs/EdgeLineEntityListing.md +1 -1
- data/docs/EmailConversationEntityListing.md +1 -1
- data/docs/EmailMediaParticipant.md +2 -0
- data/docs/EmailMessageListing.md +1 -1
- data/docs/EmergencyGroupListing.md +1 -1
- data/docs/EncryptionKeyEntityListing.md +1 -1
- data/docs/EvaluationEntityListing.md +1 -1
- data/docs/EvaluationFormEntityListing.md +1 -1
- data/docs/EvaluatorActivityEntityListing.md +1 -1
- data/docs/ExtensionEntityListing.md +1 -1
- data/docs/ExtensionPoolEntityListing.md +1 -1
- data/docs/ExternalOrganizationListing.md +1 -1
- data/docs/FacebookIntegrationEntityListing.md +1 -1
- data/docs/FaxDocumentEntityListing.md +1 -1
- data/docs/FlowAggregationQuery.md +1 -0
- data/docs/FlowDivisionView.md +2 -0
- data/docs/FlowDivisionViewEntityListing.md +1 -1
- data/docs/FlowEntityListing.md +1 -1
- data/docs/FlowOutcomeListing.md +1 -1
- data/docs/FlowVersionEntityListing.md +1 -1
- data/docs/GDPRRequestEntityListing.md +1 -1
- data/docs/GDPRSubjectEntityListing.md +1 -1
- data/docs/GreetingListing.md +1 -1
- data/docs/GroupEntityListing.md +1 -1
- data/docs/GroupProfileEntityListing.md +1 -1
- data/docs/IVREntityListing.md +1 -1
- data/docs/InboundDomainEntityListing.md +1 -1
- data/docs/InboundRouteEntityListing.md +1 -1
- data/docs/IntegrationEntityListing.md +1 -1
- data/docs/IntegrationEventEntityListing.md +1 -1
- data/docs/IntegrationType.md +1 -0
- data/docs/IntegrationTypeEntityListing.md +1 -1
- data/docs/InteractionStatsAlertContainer.md +1 -1
- data/docs/InteractionStatsRuleContainer.md +1 -1
- data/docs/KeywordSetEntityListing.md +1 -1
- data/docs/LanguageEntityListing.md +1 -1
- data/docs/LexBotAliasEntityListing.md +1 -1
- data/docs/LexBotEntityListing.md +1 -1
- data/docs/LibraryEntityListing.md +1 -1
- data/docs/LineBaseEntityListing.md +1 -1
- data/docs/LineEntityListing.md +1 -1
- data/docs/LineIntegrationEntityListing.md +1 -1
- data/docs/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/ManagementUnit.md +1 -1
- data/docs/ManagementUnitListing.md +1 -1
- data/docs/{UserExternalIdentifier.md → ManagementUnitReference.md} +3 -4
- data/docs/{ManagementUnitSettings.md → ManagementUnitSettingsRequest.md} +3 -3
- data/docs/ManagementUnitSettingsResponse.md +18 -0
- 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 +250 -2
- data/docs/RuleSetEntityListing.md +1 -1
- data/docs/SCIMApi.md +302 -26
- data/docs/ScheduleEntityListing.md +1 -1
- data/docs/ScheduleGroupEntityListing.md +1 -1
- data/docs/{SchedulingSettings.md → SchedulingSettingsRequest.md} +2 -2
- data/docs/SchedulingSettingsResponse.md +15 -0
- data/docs/SchemaCategoryEntityListing.md +1 -1
- data/docs/SchemaReferenceEntityListing.md +1 -1
- data/docs/ScimConfigResourceType.md +1 -1
- data/docs/ScimConfigResourceTypeSchemaExtension.md +1 -1
- data/docs/ScimError.md +4 -4
- data/docs/ScimServiceProviderConfig.md +7 -7
- data/docs/ScimServiceProviderConfigAuthenticationScheme.md +1 -1
- data/docs/ScimV2CreateUser.md +1 -1
- data/docs/ScimV2Group.md +3 -2
- data/docs/ScimV2User.md +2 -2
- 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/SendAgentlessOutboundMessageRequest.md +16 -0
- data/docs/SendAgentlessOutboundMessageResponse.md +21 -0
- data/docs/ShareEntityListing.md +1 -1
- data/docs/ShiftTradeSettings.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/TextMessageListing.md +1 -1
- data/docs/TimeOffRequestLookup.md +13 -0
- data/docs/TimeZoneEntityListing.md +1 -1
- data/docs/TranscriptionSettings.md +14 -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/TtsEngineEntityListing.md +1 -1
- data/docs/TtsVoiceEntityListing.md +1 -1
- data/docs/TwitterIntegrationEntityListing.md +1 -1
- data/docs/UpdateManagementUnitRequest.md +1 -1
- data/docs/UserActionCategoryEntityListing.md +1 -1
- data/docs/UserAggregationQuery.md +1 -0
- data/docs/UserDetailsQuery.md +1 -1
- data/docs/UserEntityListing.md +1 -1
- data/docs/UserLanguageEntityListing.md +1 -1
- data/docs/UserProfileEntityListing.md +1 -1
- data/docs/UserQueueEntityListing.md +1 -1
- data/docs/UserRecordingEntityListing.md +1 -1
- data/docs/UserSkillEntityListing.md +1 -1
- data/docs/UsersApi.md +101 -306
- data/docs/ValueWrapperPlanningPeriodSettings.md +13 -0
- data/docs/VoicemailMessageEntityListing.md +1 -1
- data/docs/WebChatMemberInfoEntityList.md +1 -1
- data/docs/WfmForecastModificationIntervalOffsetValue.md +1 -1
- data/docs/WhatsAppIntegrationEntityListing.md +1 -1
- data/docs/WhatsAppIntegrationRequest.md +17 -0
- data/docs/WorkPlan.md +1 -0
- data/docs/WorkPlanListItemResponse.md +1 -0
- data/docs/WorkPlanReference.md +3 -1
- data/docs/WorkPlanShift.md +1 -0
- data/docs/WorkforceManagementApi.md +80 -9
- data/docs/WorkspaceEntityListing.md +1 -1
- data/docs/WorkspaceMemberEntityListing.md +1 -1
- data/docs/WrapupCodeEntityListing.md +1 -1
- data/lib/purecloudplatformclientv2.rb +23 -5
- data/lib/purecloudplatformclientv2/api/architect_api.rb +24 -6
- data/lib/purecloudplatformclientv2/api/authorization_api.rb +157 -0
- data/lib/purecloudplatformclientv2/api/conversations_api.rb +195 -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 +239 -9
- data/lib/purecloudplatformclientv2/api/scim_api.rb +364 -20
- data/lib/purecloudplatformclientv2/api/users_api.rb +127 -353
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +81 -8
- 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_flow.rb +2 -2
- data/lib/purecloudplatformclientv2/models/analytics_session.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/bu_search_agent_schedules_request.rb +266 -0
- data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/call_media_participant.rb +53 -1
- data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/callback_media_participant.rb +53 -1
- data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/chat_media_participant.rb +53 -1
- data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb +53 -1
- data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_center_settings.rb +202 -0
- data/lib/purecloudplatformclientv2/models/contact_list_division_view_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/conversation_aggregate_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/conversation_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_management_unit_api_request.rb +1 -1
- data/lib/purecloudplatformclientv2/models/{create_management_unit_settings.rb → create_management_unit_settings_request.rb} +2 -2
- data/lib/purecloudplatformclientv2/models/create_work_plan.rb +27 -1
- data/lib/purecloudplatformclientv2/models/create_work_plan_shift.rb +27 -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.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 +105 -1
- data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/email_media_participant.rb +53 -1
- data/lib/purecloudplatformclientv2/models/email_message_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/evaluation_aggregation_query.rb +2 -2
- data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/event_log.rb +2 -2
- 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/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/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.rb +1 -1
- data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/{user_external_identifier.rb → management_unit_reference.rb} +10 -46
- data/lib/purecloudplatformclientv2/models/{management_unit_settings.rb → management_unit_settings_request.rb} +2 -2
- data/lib/purecloudplatformclientv2/models/management_unit_settings_response.rb +337 -0
- 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/photo.rb +1 -1
- 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 +58 -4
- data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +55 -1
- data/lib/purecloudplatformclientv2/models/response_entity_list.rb +12 -12
- data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/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 → scheduling_settings_request.rb} +1 -1
- data/lib/purecloudplatformclientv2/models/scheduling_settings_response.rb +255 -0
- 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 +2 -2
- data/lib/purecloudplatformclientv2/models/scim_config_resource_type_schema_extension.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_config_resource_types_list_response.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_email.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_error.rb +5 -5
- data/lib/purecloudplatformclientv2/models/scim_group_list_response.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_metadata.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_phone_number.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_service_provider_config.rb +8 -8
- data/lib/purecloudplatformclientv2/models/scim_service_provider_config_authentication_scheme.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_service_provider_config_bulk_feature.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_service_provider_config_filter_feature.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_service_provider_config_simple_feature.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_user_list_response.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_v2_create_user.rb +2 -1
- data/lib/purecloudplatformclientv2/models/scim_v2_enterprise_user.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_v2_group.rb +34 -3
- data/lib/purecloudplatformclientv2/models/scim_v2_group_reference.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_v2_member_reference.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_v2_patch_operation.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_v2_patch_request.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_v2_user.rb +3 -2
- 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/segment_detail_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/selected_columns.rb +228 -0
- data/lib/purecloudplatformclientv2/models/send_agentless_outbound_message_request.rb +314 -0
- data/lib/purecloudplatformclientv2/models/send_agentless_outbound_message_response.rb +424 -0
- data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/shift_trade_settings.rb +27 -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/transcription_settings.rb +252 -0
- 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 +2 -2
- data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/tts_engine_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/tts_voice_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/twitter_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/update_management_unit_request.rb +1 -1
- 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 +32 -31
- 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/value_wrapper_planning_period_settings.rb +203 -0
- data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/web_chat_member_info_entity_list.rb +12 -12
- data/lib/purecloudplatformclientv2/models/wfm_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/whats_app_integration_request.rb +321 -0
- data/lib/purecloudplatformclientv2/models/work_plan.rb +27 -1
- data/lib/purecloudplatformclientv2/models/work_plan_list_item_response.rb +27 -1
- data/lib/purecloudplatformclientv2/models/work_plan_reference.rb +57 -9
- data/lib/purecloudplatformclientv2/models/work_plan_shift.rb +27 -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 +48 -12
- data/docs/LocationCreateUpdateDefinition.md +0 -21
|
@@ -14,8 +14,8 @@ title: LogicalInterfaceEntityListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/ManagementUnit.md
CHANGED
|
@@ -12,7 +12,7 @@ title: ManagementUnit
|
|
|
12
12
|
| **division** | [**Division**](Division.html) | The division to which this entity belongs. | [optional] |
|
|
13
13
|
| **start_day_of_week** | **String** | Start day of week for scheduling and forecasting purposes | [optional] |
|
|
14
14
|
| **time_zone** | **String** | The time zone for the management unit in standard Olson format | [optional] |
|
|
15
|
-
| **settings** | [**
|
|
15
|
+
| **settings** | [**ManagementUnitSettingsResponse**](ManagementUnitSettingsResponse.html) | The configuration settings for this management unit | [optional] |
|
|
16
16
|
| **metadata** | [**WfmVersionedEntityMetadata**](WfmVersionedEntityMetadata.html) | Version info metadata for this management unit. Deprecated, use settings.metadata | [optional] |
|
|
17
17
|
| **version** | **Integer** | The version of the underlying entity. Deprecated, use field from settings.metadata instead | [optional] |
|
|
18
18
|
| **date_modified** | **DateTime** | The date and time at which this entity was last modified. Deprecated, use field from settings.metadata instead. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
@@ -14,8 +14,8 @@ title: ManagementUnitListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -1,14 +1,13 @@
|
|
|
1
1
|
---
|
|
2
|
-
title:
|
|
2
|
+
title: ManagementUnitReference
|
|
3
3
|
---
|
|
4
|
-
## PureCloud::
|
|
4
|
+
## PureCloud::ManagementUnitReference
|
|
5
5
|
|
|
6
6
|
## Properties
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **
|
|
11
|
-
| **external_key** | **String** | External Key | |
|
|
10
|
+
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
12
11
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
13
12
|
{: class="table table-striped"}
|
|
14
13
|
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
|
-
title:
|
|
2
|
+
title: ManagementUnitSettingsRequest
|
|
3
3
|
---
|
|
4
|
-
## PureCloud::
|
|
4
|
+
## PureCloud::ManagementUnitSettingsRequest
|
|
5
5
|
|
|
6
6
|
## Properties
|
|
7
7
|
|
|
@@ -10,7 +10,7 @@ title: ManagementUnitSettings
|
|
|
10
10
|
| **adherence** | [**AdherenceSettings**](AdherenceSettings.html) | Adherence settings for this management unit | [optional] |
|
|
11
11
|
| **short_term_forecasting** | [**ShortTermForecastingSettings**](ShortTermForecastingSettings.html) | Short term forecasting settings for this management unit | [optional] |
|
|
12
12
|
| **time_off** | [**TimeOffRequestSettings**](TimeOffRequestSettings.html) | Time off request settings for this management unit | [optional] |
|
|
13
|
-
| **scheduling** | [**
|
|
13
|
+
| **scheduling** | [**SchedulingSettingsRequest**](SchedulingSettingsRequest.html) | Scheduling settings for this management unit | [optional] |
|
|
14
14
|
| **shift_trading** | [**ShiftTradeSettings**](ShiftTradeSettings.html) | Shift trade settings for this management unit | [optional] |
|
|
15
15
|
| **metadata** | [**WfmVersionedEntityMetadata**](WfmVersionedEntityMetadata.html) | Version info metadata for the associated management unit | |
|
|
16
16
|
{: class="table table-striped"}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ManagementUnitSettingsResponse
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::ManagementUnitSettingsResponse
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **adherence** | [**AdherenceSettings**](AdherenceSettings.html) | Adherence settings for this management unit | [optional] |
|
|
11
|
+
| **short_term_forecasting** | [**ShortTermForecastingSettings**](ShortTermForecastingSettings.html) | Short term forecasting settings for this management unit | [optional] |
|
|
12
|
+
| **time_off** | [**TimeOffRequestSettings**](TimeOffRequestSettings.html) | Time off request settings for this management unit | [optional] |
|
|
13
|
+
| **scheduling** | [**SchedulingSettingsResponse**](SchedulingSettingsResponse.html) | Scheduling settings for this management unit | [optional] |
|
|
14
|
+
| **shift_trading** | [**ShiftTradeSettings**](ShiftTradeSettings.html) | Shift trade settings for this management unit | [optional] |
|
|
15
|
+
| **metadata** | [**WfmVersionedEntityMetadata**](WfmVersionedEntityMetadata.html) | Version info metadata for the associated management unit | |
|
|
16
|
+
{: class="table table-striped"}
|
|
17
|
+
|
|
18
|
+
|
|
@@ -14,8 +14,8 @@ title: MessageConversationEntityListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: MessageEvaluation
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::MessageEvaluation
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **contact_column** | **String** | | [optional] |
|
|
11
|
+
| **contact_address** | **String** | | [optional] |
|
|
12
|
+
| **wrapup_code_id** | **String** | | [optional] |
|
|
13
|
+
| **timestamp** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
14
|
+
{: class="table table-striped"}
|
|
15
|
+
|
|
16
|
+
|
|
@@ -37,6 +37,8 @@ title: MessageMediaParticipant
|
|
|
37
37
|
| **flagged_reason** | **String** | The reason specifying why participant flagged the conversation. | [optional] |
|
|
38
38
|
| **journey_context** | [**JourneyContext**](JourneyContext.html) | Journey System data/context that is applicable to this communication. When used for historical purposes, the context should be immutable. When null, there is no applicable Journey System context. | [optional] |
|
|
39
39
|
| **conversation_routing_data** | [**ConversationRoutingData**](ConversationRoutingData.html) | Information on how a communication should be routed to an agent. | [optional] |
|
|
40
|
+
| **start_acw_time** | **DateTime** | The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
41
|
+
| **end_acw_time** | **DateTime** | The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
40
42
|
| **to_address** | [**Address**](Address.html) | Address for the participant on receiving side of the message conversation. If the address is a phone number, E.164 format is recommended. | [optional] |
|
|
41
43
|
| **from_address** | [**Address**](Address.html) | Address for the participant on the sending side of the message conversation. If the address is a phone number, E.164 format is recommended. | [optional] |
|
|
42
44
|
| **messages** | [**Array<MessageDetails>**](MessageDetails.html) | Message instance details on the communication. | [optional] |
|
|
@@ -14,8 +14,8 @@ title: MessagingIntegrationEntityListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -14,8 +14,8 @@ title: MessagingStickerEntityListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/NoteListing.md
CHANGED
|
@@ -14,8 +14,8 @@ title: NoteListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/NotificationsApi.md
CHANGED
|
@@ -349,7 +349,7 @@ Name | Type | Description | Notes
|
|
|
349
349
|
|
|
350
350
|
Create a new channel
|
|
351
351
|
|
|
352
|
-
There is a limit of
|
|
352
|
+
There is a limit of 20 channels per user/app combination. Creating a 21st channel will remove the channel with oldest last used date.
|
|
353
353
|
|
|
354
354
|
Wraps POST /api/v2/notifications/channels
|
|
355
355
|
|
|
@@ -14,8 +14,8 @@ title: OAuthClientEntityListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -14,8 +14,8 @@ title: OAuthProviderEntityListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -14,8 +14,8 @@ title: OrganizationPresenceEntityListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -14,8 +14,8 @@ title: OrganizationRoleEntityListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -14,8 +14,8 @@ title: OrphanRecordingListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -14,8 +14,8 @@ title: OutboundRouteBaseEntityListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -14,8 +14,8 @@ title: OutboundRouteEntityListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/Participant.md
CHANGED
|
@@ -48,6 +48,8 @@ title: Participant
|
|
|
48
48
|
| **evaluations** | [**Array<Evaluation>**](Evaluation.html) | | [optional] |
|
|
49
49
|
| **screen_recording_state** | **String** | The current screen recording state for this participant. | [optional] |
|
|
50
50
|
| **flagged_reason** | **String** | The reason specifying why participant flagged the conversation. | [optional] |
|
|
51
|
+
| **start_acw_time** | **DateTime** | The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
52
|
+
| **end_acw_time** | **DateTime** | The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
51
53
|
{: class="table table-striped"}
|
|
52
54
|
|
|
53
55
|
|
data/docs/ParticipantBasic.md
CHANGED
|
@@ -48,6 +48,8 @@ title: ParticipantBasic
|
|
|
48
48
|
| **evaluations** | [**Array<Evaluation>**](Evaluation.html) | | [optional] |
|
|
49
49
|
| **screen_recording_state** | **String** | The current screen recording state for this participant. | [optional] |
|
|
50
50
|
| **flagged_reason** | **String** | The reason specifying why participant flagged the conversation. | [optional] |
|
|
51
|
+
| **start_acw_time** | **DateTime** | The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
52
|
+
| **end_acw_time** | **DateTime** | The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
51
53
|
{: class="table table-striped"}
|
|
52
54
|
|
|
53
55
|
|
|
@@ -14,8 +14,8 @@ title: PermissionCollectionEntityListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -14,8 +14,8 @@ title: PhoneBaseEntityListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/PhoneEntityListing.md
CHANGED
|
@@ -14,8 +14,8 @@ title: PhoneEntityListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -14,8 +14,8 @@ title: PhoneMetaBaseEntityListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -14,8 +14,8 @@ title: PhysicalInterfaceEntityListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: PlanningPeriodSettings
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::PlanningPeriodSettings
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **week_count** | **Integer** | Planning period length in weeks | |
|
|
11
|
+
| **start_date** | **Date** | Start date of the planning period in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd | |
|
|
12
|
+
{: class="table table-striped"}
|
|
13
|
+
|
|
14
|
+
|
data/docs/PolicyEntityListing.md
CHANGED
|
@@ -14,8 +14,8 @@ title: PolicyEntityListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -14,8 +14,8 @@ title: PromptAssetEntityListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/PromptEntityListing.md
CHANGED
|
@@ -14,8 +14,8 @@ title: PromptEntityListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/QualityApi.md
CHANGED
|
@@ -80,8 +80,9 @@ Delete a calibration by id.
|
|
|
80
80
|
|
|
81
81
|
Wraps DELETE /api/v2/quality/calibrations/{calibrationId}
|
|
82
82
|
|
|
83
|
-
Requires
|
|
83
|
+
Requires ANY permissions:
|
|
84
84
|
|
|
85
|
+
* quality:calibration:delete
|
|
85
86
|
|
|
86
87
|
|
|
87
88
|
### Example
|
|
@@ -147,8 +148,9 @@ Delete an evaluation
|
|
|
147
148
|
|
|
148
149
|
Wraps DELETE /api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId}
|
|
149
150
|
|
|
150
|
-
Requires
|
|
151
|
+
Requires ANY permissions:
|
|
151
152
|
|
|
153
|
+
* quality:evaluation:delete
|
|
152
154
|
|
|
153
155
|
|
|
154
156
|
### Example
|
|
@@ -410,8 +412,9 @@ Delete a keywordSet by id.
|
|
|
410
412
|
|
|
411
413
|
Wraps DELETE /api/v2/quality/keywordsets/{keywordSetId}
|
|
412
414
|
|
|
413
|
-
Requires
|
|
415
|
+
Requires ANY permissions:
|
|
414
416
|
|
|
417
|
+
* quality:keywordset:delete
|
|
415
418
|
|
|
416
419
|
|
|
417
420
|
### Example
|
|
@@ -473,8 +476,9 @@ Bulk delete of keyword sets; this will only delete the keyword sets that match t
|
|
|
473
476
|
|
|
474
477
|
Wraps DELETE /api/v2/quality/keywordsets
|
|
475
478
|
|
|
476
|
-
Requires
|
|
479
|
+
Requires ANY permissions:
|
|
477
480
|
|
|
481
|
+
* quality:keywordset:delete
|
|
478
482
|
|
|
479
483
|
|
|
480
484
|
### Example
|
|
@@ -536,8 +540,9 @@ Including the number of evaluations and average evaluation score
|
|
|
536
540
|
|
|
537
541
|
Wraps GET /api/v2/quality/agents/activity
|
|
538
542
|
|
|
539
|
-
Requires
|
|
543
|
+
Requires ANY permissions:
|
|
540
544
|
|
|
545
|
+
* quality:evaluation:view
|
|
541
546
|
|
|
542
547
|
|
|
543
548
|
### Example
|
|
@@ -623,8 +628,9 @@ Get a calibration by id. Requires either calibrator id or conversation id
|
|
|
623
628
|
|
|
624
629
|
Wraps GET /api/v2/quality/calibrations/{calibrationId}
|
|
625
630
|
|
|
626
|
-
Requires
|
|
631
|
+
Requires ANY permissions:
|
|
627
632
|
|
|
633
|
+
* quality:calibration:view
|
|
628
634
|
|
|
629
635
|
|
|
630
636
|
### Example
|
|
@@ -693,8 +699,9 @@ Get the list of calibrations
|
|
|
693
699
|
|
|
694
700
|
Wraps GET /api/v2/quality/calibrations
|
|
695
701
|
|
|
696
|
-
Requires
|
|
702
|
+
Requires ANY permissions:
|
|
697
703
|
|
|
704
|
+
* quality:calibration:view
|
|
698
705
|
|
|
699
706
|
|
|
700
707
|
### Example
|
|
@@ -773,12 +780,18 @@ Name | Type | Description | Notes
|
|
|
773
780
|
|
|
774
781
|
Get audits for conversation or recording
|
|
775
782
|
|
|
776
|
-
|
|
783
|
+
Different permissions are required for viewing different resource audit entries. The quality:evaluation:viewAudit permission is required to view evaluation audits, the recording:recording:viewAudit permission is required to view recording audits, and so on.
|
|
777
784
|
|
|
778
785
|
Wraps GET /api/v2/quality/conversations/{conversationId}/audits
|
|
779
786
|
|
|
780
|
-
Requires
|
|
787
|
+
Requires ANY permissions:
|
|
781
788
|
|
|
789
|
+
* quality:calibration:viewAudit
|
|
790
|
+
* quality:evaluation:viewAudit
|
|
791
|
+
* quality:survey:viewAudit
|
|
792
|
+
* recording:recording:viewAudit
|
|
793
|
+
* recording:annotation:viewAudit
|
|
794
|
+
* recording:screenRecording:viewAudit
|
|
782
795
|
|
|
783
796
|
|
|
784
797
|
### Example
|
|
@@ -859,8 +872,9 @@ Get an evaluation
|
|
|
859
872
|
|
|
860
873
|
Wraps GET /api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId}
|
|
861
874
|
|
|
862
|
-
Requires
|
|
875
|
+
Requires ANY permissions:
|
|
863
876
|
|
|
877
|
+
* quality:evaluation:view
|
|
864
878
|
|
|
865
879
|
|
|
866
880
|
### Example
|
|
@@ -930,8 +944,9 @@ Get the surveys for a conversation
|
|
|
930
944
|
|
|
931
945
|
Wraps GET /api/v2/quality/conversations/{conversationId}/surveys
|
|
932
946
|
|
|
933
|
-
Requires
|
|
947
|
+
Requires ANY permissions:
|
|
934
948
|
|
|
949
|
+
* quality:survey:view
|
|
935
950
|
|
|
936
951
|
|
|
937
952
|
### Example
|
|
@@ -994,8 +1009,9 @@ Query params must include one of conversationId, evaluatorUserId, or agentUserId
|
|
|
994
1009
|
|
|
995
1010
|
Wraps GET /api/v2/quality/evaluations/query
|
|
996
1011
|
|
|
997
|
-
Requires
|
|
1012
|
+
Requires ANY permissions:
|
|
998
1013
|
|
|
1014
|
+
* quality:evaluation:view
|
|
999
1015
|
|
|
1000
1016
|
|
|
1001
1017
|
### Example
|
|
@@ -1093,8 +1109,9 @@ Get an evaluator activity
|
|
|
1093
1109
|
|
|
1094
1110
|
Wraps GET /api/v2/quality/evaluators/activity
|
|
1095
1111
|
|
|
1096
|
-
Requires
|
|
1112
|
+
Requires ANY permissions:
|
|
1097
1113
|
|
|
1114
|
+
* quality:evaluation:view
|
|
1098
1115
|
|
|
1099
1116
|
|
|
1100
1117
|
### Example
|
|
@@ -1960,8 +1977,9 @@ Get a keywordSet by id.
|
|
|
1960
1977
|
|
|
1961
1978
|
Wraps GET /api/v2/quality/keywordsets/{keywordSetId}
|
|
1962
1979
|
|
|
1963
|
-
Requires
|
|
1980
|
+
Requires ANY permissions:
|
|
1964
1981
|
|
|
1982
|
+
* quality:keywordset:view
|
|
1965
1983
|
|
|
1966
1984
|
|
|
1967
1985
|
### Example
|
|
@@ -2024,8 +2042,9 @@ Get the list of keyword sets
|
|
|
2024
2042
|
|
|
2025
2043
|
Wraps GET /api/v2/quality/keywordsets
|
|
2026
2044
|
|
|
2027
|
-
Requires
|
|
2045
|
+
Requires ANY permissions:
|
|
2028
2046
|
|
|
2047
|
+
* quality:keywordset:view
|
|
2029
2048
|
|
|
2030
2049
|
|
|
2031
2050
|
### Example
|
|
@@ -2518,8 +2537,9 @@ Get a survey for a conversation
|
|
|
2518
2537
|
|
|
2519
2538
|
Wraps GET /api/v2/quality/surveys/{surveyId}
|
|
2520
2539
|
|
|
2521
|
-
Requires
|
|
2540
|
+
Requires ANY permissions:
|
|
2522
2541
|
|
|
2542
|
+
* quality:survey:view
|
|
2523
2543
|
|
|
2524
2544
|
|
|
2525
2545
|
### Example
|
|
@@ -2835,8 +2855,9 @@ Create a calibration
|
|
|
2835
2855
|
|
|
2836
2856
|
Wraps POST /api/v2/quality/calibrations
|
|
2837
2857
|
|
|
2838
|
-
Requires
|
|
2858
|
+
Requires ANY permissions:
|
|
2839
2859
|
|
|
2860
|
+
* quality:calibration:add
|
|
2840
2861
|
|
|
2841
2862
|
|
|
2842
2863
|
### Example
|
|
@@ -2903,8 +2924,9 @@ Create an evaluation
|
|
|
2903
2924
|
|
|
2904
2925
|
Wraps POST /api/v2/quality/conversations/{conversationId}/evaluations
|
|
2905
2926
|
|
|
2906
|
-
Requires
|
|
2927
|
+
Requires ANY permissions:
|
|
2907
2928
|
|
|
2929
|
+
* quality:evaluation:add
|
|
2908
2930
|
|
|
2909
2931
|
|
|
2910
2932
|
### Example
|
|
@@ -3233,8 +3255,9 @@ Create a Keyword Set
|
|
|
3233
3255
|
|
|
3234
3256
|
Wraps POST /api/v2/quality/keywordsets
|
|
3235
3257
|
|
|
3236
|
-
Requires
|
|
3258
|
+
Requires ANY permissions:
|
|
3237
3259
|
|
|
3260
|
+
* quality:keywordset:add
|
|
3238
3261
|
|
|
3239
3262
|
|
|
3240
3263
|
### Example
|
|
@@ -3625,8 +3648,9 @@ Update a calibration to the specified calibration via PUT. Editable fields incl
|
|
|
3625
3648
|
|
|
3626
3649
|
Wraps PUT /api/v2/quality/calibrations/{calibrationId}
|
|
3627
3650
|
|
|
3628
|
-
Requires
|
|
3651
|
+
Requires ANY permissions:
|
|
3629
3652
|
|
|
3653
|
+
* quality:calibration:edit
|
|
3630
3654
|
|
|
3631
3655
|
|
|
3632
3656
|
### Example
|
|
@@ -3688,12 +3712,15 @@ Name | Type | Description | Notes
|
|
|
3688
3712
|
|
|
3689
3713
|
Update an evaluation
|
|
3690
3714
|
|
|
3691
|
-
|
|
3715
|
+
The quality:evaluation:edit permission allows modification of most fields, while the quality:evaluation:editScore permission allows an evaluator to change just the question scores, and the quality:evaluation:editAgentSignoff permission allows an agent to change the agent comments and sign off on the evaluation.
|
|
3692
3716
|
|
|
3693
3717
|
Wraps PUT /api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId}
|
|
3694
3718
|
|
|
3695
|
-
Requires
|
|
3719
|
+
Requires ANY permissions:
|
|
3696
3720
|
|
|
3721
|
+
* quality:evaluation:edit
|
|
3722
|
+
* quality:evaluation:editScore
|
|
3723
|
+
* quality:evaluation:editAgentSignoff
|
|
3697
3724
|
|
|
3698
3725
|
|
|
3699
3726
|
### Example
|
|
@@ -3970,8 +3997,9 @@ Update a keywordSet to the specified keywordSet via PUT.
|
|
|
3970
3997
|
|
|
3971
3998
|
Wraps PUT /api/v2/quality/keywordsets/{keywordSetId}
|
|
3972
3999
|
|
|
3973
|
-
Requires
|
|
4000
|
+
Requires ANY permissions:
|
|
3974
4001
|
|
|
4002
|
+
* quality:keywordset:edit
|
|
3975
4003
|
|
|
3976
4004
|
|
|
3977
4005
|
### Example
|