purecloudplatformclientv2 64.0.1 → 69.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/docs/ActionEntityListing.md +1 -1
- data/docs/AgentActivityEntityListing.md +1 -1
- data/docs/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/QualityAuditPage.md
CHANGED
|
@@ -11,8 +11,8 @@ title: QualityAuditPage
|
|
|
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] |
|
|
@@ -12,6 +12,7 @@ title: QueueConversationCallEventTopicCallConversation
|
|
|
12
12
|
| **participants** | [**Array<QueueConversationCallEventTopicCallMediaParticipant>**](QueueConversationCallEventTopicCallMediaParticipant.html) | | [optional] |
|
|
13
13
|
| **other_media_uris** | **Array<String>** | | [optional] |
|
|
14
14
|
| **recording_state** | **String** | | [optional] |
|
|
15
|
+
| **max_participants** | **Integer** | | [optional] |
|
|
15
16
|
{: class="table table-striped"}
|
|
16
17
|
|
|
17
18
|
|
|
@@ -38,6 +38,8 @@ title: QueueConversationCallEventTopicCallMediaParticipant
|
|
|
38
38
|
| **screen_recording_state** | **String** | | [optional] |
|
|
39
39
|
| **flagged_reason** | **String** | | [optional] |
|
|
40
40
|
| **journey_context** | [**QueueConversationCallEventTopicJourneyContext**](QueueConversationCallEventTopicJourneyContext.html) | | [optional] |
|
|
41
|
+
| **start_acw_time** | **DateTime** | | [optional] |
|
|
42
|
+
| **end_acw_time** | **DateTime** | | [optional] |
|
|
41
43
|
| **muted** | **BOOLEAN** | | [optional] |
|
|
42
44
|
| **confined** | **BOOLEAN** | | [optional] |
|
|
43
45
|
| **recording** | **BOOLEAN** | | [optional] |
|
|
@@ -38,6 +38,8 @@ title: QueueConversationCallbackEventTopicCallbackMediaParticipant
|
|
|
38
38
|
| **screen_recording_state** | **String** | | [optional] |
|
|
39
39
|
| **flagged_reason** | **String** | | [optional] |
|
|
40
40
|
| **journey_context** | [**QueueConversationCallbackEventTopicJourneyContext**](QueueConversationCallbackEventTopicJourneyContext.html) | | [optional] |
|
|
41
|
+
| **start_acw_time** | **DateTime** | | [optional] |
|
|
42
|
+
| **end_acw_time** | **DateTime** | | [optional] |
|
|
41
43
|
| **outbound_preview** | [**QueueConversationCallbackEventTopicDialerPreview**](QueueConversationCallbackEventTopicDialerPreview.html) | | [optional] |
|
|
42
44
|
| **voicemail** | [**QueueConversationCallbackEventTopicVoicemail**](QueueConversationCallbackEventTopicVoicemail.html) | | [optional] |
|
|
43
45
|
| **callback_numbers** | **Array<String>** | | [optional] |
|
|
@@ -38,6 +38,8 @@ title: QueueConversationChatEventTopicChatMediaParticipant
|
|
|
38
38
|
| **screen_recording_state** | **String** | | [optional] |
|
|
39
39
|
| **flagged_reason** | **String** | | [optional] |
|
|
40
40
|
| **journey_context** | [**QueueConversationChatEventTopicJourneyContext**](QueueConversationChatEventTopicJourneyContext.html) | | [optional] |
|
|
41
|
+
| **start_acw_time** | **DateTime** | | [optional] |
|
|
42
|
+
| **end_acw_time** | **DateTime** | | [optional] |
|
|
41
43
|
| **room_id** | **String** | | [optional] |
|
|
42
44
|
| **avatar_image_url** | **String** | | [optional] |
|
|
43
45
|
{: class="table table-striped"}
|
|
@@ -38,6 +38,8 @@ title: QueueConversationCobrowseEventTopicCobrowseMediaParticipant
|
|
|
38
38
|
| **screen_recording_state** | **String** | | [optional] |
|
|
39
39
|
| **flagged_reason** | **String** | | [optional] |
|
|
40
40
|
| **journey_context** | [**QueueConversationCobrowseEventTopicJourneyContext**](QueueConversationCobrowseEventTopicJourneyContext.html) | | [optional] |
|
|
41
|
+
| **start_acw_time** | **DateTime** | | [optional] |
|
|
42
|
+
| **end_acw_time** | **DateTime** | | [optional] |
|
|
41
43
|
| **cobrowse_session_id** | **String** | | [optional] |
|
|
42
44
|
| **cobrowse_role** | **String** | | [optional] |
|
|
43
45
|
| **viewer_url** | **String** | | [optional] |
|
|
@@ -38,6 +38,8 @@ title: QueueConversationEmailEventTopicEmailMediaParticipant
|
|
|
38
38
|
| **screen_recording_state** | **String** | | [optional] |
|
|
39
39
|
| **flagged_reason** | **String** | | [optional] |
|
|
40
40
|
| **journey_context** | [**QueueConversationEmailEventTopicJourneyContext**](QueueConversationEmailEventTopicJourneyContext.html) | | [optional] |
|
|
41
|
+
| **start_acw_time** | **DateTime** | | [optional] |
|
|
42
|
+
| **end_acw_time** | **DateTime** | | [optional] |
|
|
41
43
|
| **subject** | **String** | | [optional] |
|
|
42
44
|
| **messages_sent** | **Integer** | | [optional] |
|
|
43
45
|
| **auto_generated** | **BOOLEAN** | | [optional] |
|
|
@@ -24,6 +24,8 @@ title: QueueConversationEventTopicParticipant
|
|
|
24
24
|
| **wrapup_prompt** | **String** | | [optional] |
|
|
25
25
|
| **wrapup_timeout_ms** | **Integer** | | [optional] |
|
|
26
26
|
| **wrapup** | [**QueueConversationEventTopicWrapup**](QueueConversationEventTopicWrapup.html) | | [optional] |
|
|
27
|
+
| **start_acw_time** | **DateTime** | | [optional] |
|
|
28
|
+
| **end_acw_time** | **DateTime** | | [optional] |
|
|
27
29
|
| **conversation_routing_data** | [**QueueConversationEventTopicConversationRoutingData**](QueueConversationEventTopicConversationRoutingData.html) | | [optional] |
|
|
28
30
|
| **alerting_timeout_ms** | **Integer** | | [optional] |
|
|
29
31
|
| **monitored_participant_id** | **String** | | [optional] |
|
|
@@ -38,6 +38,8 @@ title: QueueConversationMessageEventTopicMessageMediaParticipant
|
|
|
38
38
|
| **screen_recording_state** | **String** | | [optional] |
|
|
39
39
|
| **flagged_reason** | **String** | | [optional] |
|
|
40
40
|
| **journey_context** | [**QueueConversationMessageEventTopicJourneyContext**](QueueConversationMessageEventTopicJourneyContext.html) | | [optional] |
|
|
41
|
+
| **start_acw_time** | **DateTime** | | [optional] |
|
|
42
|
+
| **end_acw_time** | **DateTime** | | [optional] |
|
|
41
43
|
| **messages** | [**Array<QueueConversationMessageEventTopicMessageDetails>**](QueueConversationMessageEventTopicMessageDetails.html) | | [optional] |
|
|
42
44
|
| **type** | **String** | | [optional] |
|
|
43
45
|
| **recipient_country** | **String** | | [optional] |
|
|
@@ -38,6 +38,8 @@ title: QueueConversationScreenShareEventTopicScreenShareMediaParticipant
|
|
|
38
38
|
| **screen_recording_state** | **String** | | [optional] |
|
|
39
39
|
| **flagged_reason** | **String** | | [optional] |
|
|
40
40
|
| **journey_context** | [**QueueConversationScreenShareEventTopicJourneyContext**](QueueConversationScreenShareEventTopicJourneyContext.html) | | [optional] |
|
|
41
|
+
| **start_acw_time** | **DateTime** | | [optional] |
|
|
42
|
+
| **end_acw_time** | **DateTime** | | [optional] |
|
|
41
43
|
| **context** | **String** | | [optional] |
|
|
42
44
|
| **peer_count** | **Integer** | | [optional] |
|
|
43
45
|
| **sharing** | **BOOLEAN** | | [optional] |
|
|
@@ -24,6 +24,8 @@ title: QueueConversationSocialExpressionEventTopicParticipant
|
|
|
24
24
|
| **wrapup_prompt** | **String** | | [optional] |
|
|
25
25
|
| **wrapup_timeout_ms** | **Integer** | | [optional] |
|
|
26
26
|
| **wrapup** | [**QueueConversationSocialExpressionEventTopicWrapup**](QueueConversationSocialExpressionEventTopicWrapup.html) | | [optional] |
|
|
27
|
+
| **start_acw_time** | **DateTime** | | [optional] |
|
|
28
|
+
| **end_acw_time** | **DateTime** | | [optional] |
|
|
27
29
|
| **conversation_routing_data** | [**QueueConversationSocialExpressionEventTopicConversationRoutingData**](QueueConversationSocialExpressionEventTopicConversationRoutingData.html) | | [optional] |
|
|
28
30
|
| **alerting_timeout_ms** | **Integer** | | [optional] |
|
|
29
31
|
| **monitored_participant_id** | **String** | | [optional] |
|
|
@@ -24,6 +24,8 @@ title: QueueConversationVideoEventTopicParticipant
|
|
|
24
24
|
| **wrapup_prompt** | **String** | | [optional] |
|
|
25
25
|
| **wrapup_timeout_ms** | **Integer** | | [optional] |
|
|
26
26
|
| **wrapup** | [**QueueConversationVideoEventTopicWrapup**](QueueConversationVideoEventTopicWrapup.html) | | [optional] |
|
|
27
|
+
| **start_acw_time** | **DateTime** | | [optional] |
|
|
28
|
+
| **end_acw_time** | **DateTime** | | [optional] |
|
|
27
29
|
| **conversation_routing_data** | [**QueueConversationVideoEventTopicConversationRoutingData**](QueueConversationVideoEventTopicConversationRoutingData.html) | | [optional] |
|
|
28
30
|
| **alerting_timeout_ms** | **Integer** | | [optional] |
|
|
29
31
|
| **monitored_participant_id** | **String** | | [optional] |
|
data/docs/QueueEntityListing.md
CHANGED
|
@@ -11,8 +11,8 @@ title: QueueEntityListing
|
|
|
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: QueueMemberEntityListing
|
|
|
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] |
|
|
@@ -7,11 +7,11 @@ title: QueueUserEventTopicQueueMember
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **
|
|
11
|
-
| **
|
|
12
|
-
| **
|
|
13
|
-
| **type** | **String** | | [optional] |
|
|
10
|
+
| **id** | **String** | | [optional] |
|
|
11
|
+
| **user** | [**QueueUserEventTopicUserReference**](QueueUserEventTopicUserReference.html) | | [optional] |
|
|
12
|
+
| **queue_id** | **String** | | [optional] |
|
|
14
13
|
| **joined** | **BOOLEAN** | | [optional] |
|
|
14
|
+
| **additional_properties** | **Object** | | [optional] |
|
|
15
15
|
{: class="table table-striped"}
|
|
16
16
|
|
|
17
17
|
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: QueueUserEventTopicUserReference
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::QueueUserEventTopicUserReference
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **id** | **String** | | [optional] |
|
|
11
|
+
{: class="table table-striped"}
|
|
12
|
+
|
|
13
|
+
|
data/docs/RecipientListing.md
CHANGED
|
@@ -11,8 +11,8 @@ title: RecipientListing
|
|
|
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/Recording.md
CHANGED
|
@@ -26,6 +26,7 @@ title: Recording
|
|
|
26
26
|
| **archive_date** | **DateTime** | The date the recording will be archived. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
27
27
|
| **archive_medium** | **String** | The type of archive medium used. Example: CloudArchive | [optional] |
|
|
28
28
|
| **delete_date** | **DateTime** | The date the recording will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
29
|
+
| **export_date** | **DateTime** | The date the recording will be exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
29
30
|
| **output_duration_ms** | **Integer** | Duration of transcoded media in milliseconds | [optional] |
|
|
30
31
|
| **output_size_in_bytes** | **Integer** | Size of transcoded media in bytes. 0 if there is no transcoded media. | [optional] |
|
|
31
32
|
| **max_allowed_restorations_for_org** | **Integer** | How many archive restorations the organization is allowed to have. | [optional] |
|
data/docs/RecordingApi.md
CHANGED
|
@@ -42,6 +42,7 @@ Method | Description
|
|
|
42
42
|
[**post_recording_localkeys_settings**](RecordingApi.html#post_recording_localkeys_settings) | create settings for local key creation
|
|
43
43
|
[**post_recording_mediaretentionpolicies**](RecordingApi.html#post_recording_mediaretentionpolicies) | Create media retention policy
|
|
44
44
|
[**post_recording_recordingkeys**](RecordingApi.html#post_recording_recordingkeys) | Create encryption key
|
|
45
|
+
[**post_recordings_deletionprotection**](RecordingApi.html#post_recordings_deletionprotection) | Get a list of conversations with protected recordings
|
|
45
46
|
[**put_conversation_recording**](RecordingApi.html#put_conversation_recording) | Updates the retention records on a recording.
|
|
46
47
|
[**put_conversation_recording_annotation**](RecordingApi.html#put_conversation_recording_annotation) | Update annotation
|
|
47
48
|
[**put_orphanrecording**](RecordingApi.html#put_orphanrecording) | Updates an orphan recording to a regular recording with retention values
|
|
@@ -50,6 +51,7 @@ Method | Description
|
|
|
50
51
|
[**put_recording_mediaretentionpolicy**](RecordingApi.html#put_recording_mediaretentionpolicy) | Update a media retention policy
|
|
51
52
|
[**put_recording_recordingkeys_rotationschedule**](RecordingApi.html#put_recording_recordingkeys_rotationschedule) | Update key rotation schedule
|
|
52
53
|
[**put_recording_settings**](RecordingApi.html#put_recording_settings) | Update the Recording Settings for the Organization
|
|
54
|
+
[**put_recordings_deletionprotection**](RecordingApi.html#put_recordings_deletionprotection) | Apply or revoke recording protection for conversations
|
|
53
55
|
{: class="table table-striped"}
|
|
54
56
|
|
|
55
57
|
<a name="delete_conversation_recording_annotation"></a>
|
|
@@ -64,8 +66,9 @@ Delete annotation
|
|
|
64
66
|
|
|
65
67
|
Wraps DELETE /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}
|
|
66
68
|
|
|
67
|
-
Requires
|
|
69
|
+
Requires ANY permissions:
|
|
68
70
|
|
|
71
|
+
* recording:annotation:delete
|
|
69
72
|
|
|
70
73
|
|
|
71
74
|
### Example
|
|
@@ -390,8 +393,9 @@ Gets a specific recording.
|
|
|
390
393
|
|
|
391
394
|
Wraps GET /api/v2/conversations/{conversationId}/recordings/{recordingId}
|
|
392
395
|
|
|
393
|
-
Requires
|
|
396
|
+
Requires ANY permissions:
|
|
394
397
|
|
|
398
|
+
* recording:recording:view
|
|
395
399
|
|
|
396
400
|
|
|
397
401
|
### Example
|
|
@@ -465,8 +469,9 @@ Get annotation
|
|
|
465
469
|
|
|
466
470
|
Wraps GET /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}
|
|
467
471
|
|
|
468
|
-
Requires
|
|
472
|
+
Requires ANY permissions:
|
|
469
473
|
|
|
474
|
+
* recording:annotation:view
|
|
470
475
|
|
|
471
476
|
|
|
472
477
|
### Example
|
|
@@ -535,8 +540,9 @@ Get annotations for recording
|
|
|
535
540
|
|
|
536
541
|
Wraps GET /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations
|
|
537
542
|
|
|
538
|
-
Requires
|
|
543
|
+
Requires ANY permissions:
|
|
539
544
|
|
|
545
|
+
* recording:annotation:view
|
|
540
546
|
|
|
541
547
|
|
|
542
548
|
### Example
|
|
@@ -666,8 +672,9 @@ Get metadata for a specific recording. Does not return playable media.
|
|
|
666
672
|
|
|
667
673
|
Wraps GET /api/v2/conversations/{conversationId}/recordingmetadata/{recordingId}
|
|
668
674
|
|
|
669
|
-
Requires
|
|
675
|
+
Requires ANY permissions:
|
|
670
676
|
|
|
677
|
+
* recording:recording:view
|
|
671
678
|
|
|
672
679
|
|
|
673
680
|
### Example
|
|
@@ -869,8 +876,9 @@ A 202 response means the orphaned media is currently transcoding and will be ava
|
|
|
869
876
|
|
|
870
877
|
Wraps GET /api/v2/orphanrecordings/{orphanId}/media
|
|
871
878
|
|
|
872
|
-
Requires
|
|
879
|
+
Requires ANY permissions:
|
|
873
880
|
|
|
881
|
+
* recording:orphan:view
|
|
874
882
|
|
|
875
883
|
|
|
876
884
|
### Example
|
|
@@ -1626,8 +1634,10 @@ Get the Recording Settings for the Organization
|
|
|
1626
1634
|
|
|
1627
1635
|
Wraps GET /api/v2/recording/settings
|
|
1628
1636
|
|
|
1629
|
-
Requires
|
|
1637
|
+
Requires ANY permissions:
|
|
1630
1638
|
|
|
1639
|
+
* recording:screenRecording:view
|
|
1640
|
+
* recording:settings:editScreenRecordings
|
|
1631
1641
|
|
|
1632
1642
|
|
|
1633
1643
|
### Example
|
|
@@ -1691,8 +1701,9 @@ Retrieves a paged listing of screen recording sessions
|
|
|
1691
1701
|
|
|
1692
1702
|
Wraps GET /api/v2/recordings/screensessions
|
|
1693
1703
|
|
|
1694
|
-
Requires
|
|
1704
|
+
Requires ANY permissions:
|
|
1695
1705
|
|
|
1706
|
+
* recording:screenRecording:view
|
|
1696
1707
|
|
|
1697
1708
|
|
|
1698
1709
|
### Example
|
|
@@ -1826,8 +1837,9 @@ Update a screen recording session
|
|
|
1826
1837
|
|
|
1827
1838
|
Wraps PATCH /api/v2/recordings/screensessions/{recordingSessionId}
|
|
1828
1839
|
|
|
1829
|
-
Requires
|
|
1840
|
+
Requires ANY permissions:
|
|
1830
1841
|
|
|
1842
|
+
* recording:screenRecording:stop
|
|
1831
1843
|
|
|
1832
1844
|
|
|
1833
1845
|
### Example
|
|
@@ -1893,8 +1905,9 @@ Create annotation
|
|
|
1893
1905
|
|
|
1894
1906
|
Wraps POST /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations
|
|
1895
1907
|
|
|
1896
|
-
Requires
|
|
1908
|
+
Requires ANY permissions:
|
|
1897
1909
|
|
|
1910
|
+
* recording:annotation:add
|
|
1898
1911
|
|
|
1899
1912
|
|
|
1900
1913
|
### Example
|
|
@@ -2334,6 +2347,70 @@ This endpoint does not need any parameter.
|
|
|
2334
2347
|
|
|
2335
2348
|
|
|
2336
2349
|
|
|
2350
|
+
<a name="post_recordings_deletionprotection"></a>
|
|
2351
|
+
|
|
2352
|
+
## [**Array<AddressableEntityRef>**](AddressableEntityRef.html) post_recordings_deletionprotection(body)
|
|
2353
|
+
|
|
2354
|
+
|
|
2355
|
+
|
|
2356
|
+
Get a list of conversations with protected recordings
|
|
2357
|
+
|
|
2358
|
+
|
|
2359
|
+
|
|
2360
|
+
Wraps POST /api/v2/recordings/deletionprotection
|
|
2361
|
+
|
|
2362
|
+
Requires NO permissions:
|
|
2363
|
+
|
|
2364
|
+
|
|
2365
|
+
|
|
2366
|
+
### Example
|
|
2367
|
+
```{"language":"ruby"}
|
|
2368
|
+
# load the gem
|
|
2369
|
+
require 'purecloudplatformclientv2'
|
|
2370
|
+
# setup authorization
|
|
2371
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2372
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2373
|
+
environment = "mypurecloud.com"
|
|
2374
|
+
|
|
2375
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2376
|
+
|
|
2377
|
+
PureCloud.configure do |config|
|
|
2378
|
+
config.access_token = @authToken
|
|
2379
|
+
end
|
|
2380
|
+
|
|
2381
|
+
api_instance = PureCloud::RecordingApi.new
|
|
2382
|
+
|
|
2383
|
+
body = PureCloud::ConversationDeletionProtectionQuery.new # ConversationDeletionProtectionQuery | conversationIds
|
|
2384
|
+
|
|
2385
|
+
|
|
2386
|
+
begin
|
|
2387
|
+
#Get a list of conversations with protected recordings
|
|
2388
|
+
result = api_instance.post_recordings_deletionprotection(body)
|
|
2389
|
+
p result
|
|
2390
|
+
rescue PureCloud::ApiError => e
|
|
2391
|
+
puts "Exception when calling RecordingApi->post_recordings_deletionprotection: #{e}"
|
|
2392
|
+
end
|
|
2393
|
+
```
|
|
2394
|
+
|
|
2395
|
+
### Parameters
|
|
2396
|
+
|
|
2397
|
+
Name | Type | Description | Notes
|
|
2398
|
+
------------- | ------------- | ------------- | -------------
|
|
2399
|
+
**body** | [**ConversationDeletionProtectionQuery**](ConversationDeletionProtectionQuery.html)| conversationIds | |
|
|
2400
|
+
{: class="table table-striped"}
|
|
2401
|
+
|
|
2402
|
+
|
|
2403
|
+
### Return type
|
|
2404
|
+
|
|
2405
|
+
[**Array<AddressableEntityRef>**](AddressableEntityRef.html)
|
|
2406
|
+
|
|
2407
|
+
### HTTP request headers
|
|
2408
|
+
|
|
2409
|
+
- **Content-Type**: application/json
|
|
2410
|
+
- **Accept**: application/json
|
|
2411
|
+
|
|
2412
|
+
|
|
2413
|
+
|
|
2337
2414
|
<a name="put_conversation_recording"></a>
|
|
2338
2415
|
|
|
2339
2416
|
## [**Recording**](Recording.html) put_conversation_recording(conversation_id, recording_id, body)
|
|
@@ -2342,12 +2419,15 @@ This endpoint does not need any parameter.
|
|
|
2342
2419
|
|
|
2343
2420
|
Updates the retention records on a recording.
|
|
2344
2421
|
|
|
2345
|
-
Currently supports updating and removing both archive and delete dates for eligible recordings. A request to change the archival date of an archived recording will result in a restoration of the recording until the new date set.
|
|
2422
|
+
Currently supports updating and removing both archive and delete dates for eligible recordings. A request to change the archival date of an archived recording will result in a restoration of the recording until the new date set. The recording:recording:view permission is required for the recording, as well as either the recording:recording:editRetention or recording:screenRecording:editRetention permissions depending on the type of recording.
|
|
2346
2423
|
|
|
2347
2424
|
Wraps PUT /api/v2/conversations/{conversationId}/recordings/{recordingId}
|
|
2348
2425
|
|
|
2349
|
-
Requires
|
|
2426
|
+
Requires ANY permissions:
|
|
2350
2427
|
|
|
2428
|
+
* recording:recording:view
|
|
2429
|
+
* recording:recording:editRetention
|
|
2430
|
+
* recording:screenRecording:editRetention
|
|
2351
2431
|
|
|
2352
2432
|
|
|
2353
2433
|
### Example
|
|
@@ -2416,8 +2496,9 @@ Update annotation
|
|
|
2416
2496
|
|
|
2417
2497
|
Wraps PUT /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}
|
|
2418
2498
|
|
|
2419
|
-
Requires
|
|
2499
|
+
Requires ANY permissions:
|
|
2420
2500
|
|
|
2501
|
+
* recording:annotation:edit
|
|
2421
2502
|
|
|
2422
2503
|
|
|
2423
2504
|
### Example
|
|
@@ -2827,8 +2908,9 @@ Update the Recording Settings for the Organization
|
|
|
2827
2908
|
|
|
2828
2909
|
Wraps PUT /api/v2/recording/settings
|
|
2829
2910
|
|
|
2830
|
-
Requires
|
|
2911
|
+
Requires ANY permissions:
|
|
2831
2912
|
|
|
2913
|
+
* recording:settings:editScreenRecordings
|
|
2832
2914
|
|
|
2833
2915
|
|
|
2834
2916
|
### Example
|
|
@@ -2879,3 +2961,71 @@ Name | Type | Description | Notes
|
|
|
2879
2961
|
|
|
2880
2962
|
|
|
2881
2963
|
|
|
2964
|
+
<a name="put_recordings_deletionprotection"></a>
|
|
2965
|
+
|
|
2966
|
+
## put_recordings_deletionprotection(opts)
|
|
2967
|
+
|
|
2968
|
+
|
|
2969
|
+
|
|
2970
|
+
Apply or revoke recording protection for conversations
|
|
2971
|
+
|
|
2972
|
+
|
|
2973
|
+
|
|
2974
|
+
Wraps PUT /api/v2/recordings/deletionprotection
|
|
2975
|
+
|
|
2976
|
+
Requires ANY permissions:
|
|
2977
|
+
|
|
2978
|
+
* recording:deletionProtection:apply
|
|
2979
|
+
* recording:deletionProtection:revoke
|
|
2980
|
+
|
|
2981
|
+
|
|
2982
|
+
### Example
|
|
2983
|
+
```{"language":"ruby"}
|
|
2984
|
+
# load the gem
|
|
2985
|
+
require 'purecloudplatformclientv2'
|
|
2986
|
+
# setup authorization
|
|
2987
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2988
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2989
|
+
environment = "mypurecloud.com"
|
|
2990
|
+
|
|
2991
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2992
|
+
|
|
2993
|
+
PureCloud.configure do |config|
|
|
2994
|
+
config.access_token = @authToken
|
|
2995
|
+
end
|
|
2996
|
+
|
|
2997
|
+
api_instance = PureCloud::RecordingApi.new
|
|
2998
|
+
|
|
2999
|
+
opts = {
|
|
3000
|
+
protect: true, # BOOLEAN | Check for apply, uncheck for revoke (each action requires the respective permission)
|
|
3001
|
+
body: PureCloud::ConversationDeletionProtectionQuery.new # ConversationDeletionProtectionQuery |
|
|
3002
|
+
}
|
|
3003
|
+
|
|
3004
|
+
begin
|
|
3005
|
+
#Apply or revoke recording protection for conversations
|
|
3006
|
+
api_instance.put_recordings_deletionprotection(opts)
|
|
3007
|
+
rescue PureCloud::ApiError => e
|
|
3008
|
+
puts "Exception when calling RecordingApi->put_recordings_deletionprotection: #{e}"
|
|
3009
|
+
end
|
|
3010
|
+
```
|
|
3011
|
+
|
|
3012
|
+
### Parameters
|
|
3013
|
+
|
|
3014
|
+
Name | Type | Description | Notes
|
|
3015
|
+
------------- | ------------- | ------------- | -------------
|
|
3016
|
+
**protect** | **BOOLEAN**| Check for apply, uncheck for revoke (each action requires the respective permission) | [optional] [default to true] |
|
|
3017
|
+
**body** | [**ConversationDeletionProtectionQuery**](ConversationDeletionProtectionQuery.html)| | [optional] |
|
|
3018
|
+
{: class="table table-striped"}
|
|
3019
|
+
|
|
3020
|
+
|
|
3021
|
+
### Return type
|
|
3022
|
+
|
|
3023
|
+
nil (empty response body)
|
|
3024
|
+
|
|
3025
|
+
### HTTP request headers
|
|
3026
|
+
|
|
3027
|
+
- **Content-Type**: application/json
|
|
3028
|
+
- **Accept**: application/json
|
|
3029
|
+
|
|
3030
|
+
|
|
3031
|
+
|