purecloudplatformclientv2 71.0.0 → 72.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 +3 -3
- data/docs/AgentActivityEntityListing.md +3 -3
- data/docs/AnalyticsApi.md +267 -0
- data/docs/AnalyticsUserDetailsAsyncQueryResponse.md +14 -0
- data/docs/AsyncConversationQuery.md +1 -1
- data/docs/AsyncUserDetailsQuery.md +18 -0
- data/docs/AttemptLimitsEntityListing.md +3 -3
- data/docs/AuditApi.md +216 -0
- data/docs/AuditLogMessage.md +24 -0
- data/docs/AuditQueryExecutionResultsResponse.md +16 -0
- data/docs/AuditQueryExecutionStatusResponse.md +18 -0
- data/docs/AuditQueryFilter.md +14 -0
- data/docs/AuditQueryRequest.md +15 -0
- data/docs/AuthzDivisionEntityListing.md +3 -3
- data/docs/CalibrationEntityListing.md +3 -3
- data/docs/CallConversationEntityListing.md +3 -3
- data/docs/CallHistoryConversationEntityListing.md +3 -3
- data/docs/CallableTimeSetEntityListing.md +3 -3
- data/docs/CallbackConversationEntityListing.md +3 -3
- data/docs/CampaignDivisionViewListing.md +3 -3
- data/docs/CampaignEntityListing.md +3 -3
- data/docs/CampaignRuleEntityListing.md +3 -3
- data/docs/CampaignSequenceEntityListing.md +3 -3
- data/docs/CertificateAuthorityEntityListing.md +3 -3
- data/docs/ChatConversationEntityListing.md +3 -3
- data/docs/ClientAppEntityListing.md +3 -3
- data/docs/CobrowseConversationEntityListing.md +3 -3
- data/docs/CommandStatusEntityListing.md +3 -3
- data/docs/ConsumedResourcesEntityListing.md +3 -3
- data/docs/ConsumingResourcesEntityListing.md +3 -3
- data/docs/ContactListDivisionViewListing.md +3 -3
- data/docs/ContactListEntityListing.md +3 -3
- data/docs/ContactListFilterEntityListing.md +3 -3
- data/docs/ContactListing.md +3 -3
- data/docs/ConversationAggregationQuery.md +1 -1
- data/docs/ConversationEntityListing.md +3 -3
- data/docs/ConversationQuery.md +1 -1
- data/docs/CredentialInfoListing.md +3 -3
- data/docs/CredentialTypeListing.md +3 -3
- data/docs/DIDEntityListing.md +3 -3
- data/docs/DIDPoolEntityListing.md +3 -3
- data/docs/DataTableRowEntityListing.md +3 -3
- data/docs/DataTablesDomainEntityListing.md +3 -3
- data/docs/DependencyObjectEntityListing.md +3 -3
- data/docs/DependencyTypeEntityListing.md +3 -3
- data/docs/DialerEventEntityListing.md +3 -3
- data/docs/DialogflowAgentSummaryEntityListing.md +3 -3
- data/docs/DirectoryUserDevicesListing.md +3 -3
- data/docs/DncListDivisionViewListing.md +3 -3
- data/docs/DncListEntityListing.md +3 -3
- data/docs/DocumentAuditEntityListing.md +3 -3
- data/docs/DocumentEntityListing.md +3 -3
- data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +3 -3
- data/docs/DomainEntityListing.md +3 -3
- data/docs/DomainEntityListingEvaluationForm.md +3 -3
- data/docs/DomainEntityListingQueryResult.md +3 -3
- data/docs/DomainEntityListingSurveyForm.md +3 -3
- data/docs/EdgeEntityListing.md +3 -3
- data/docs/EdgeGroupEntityListing.md +3 -3
- data/docs/EdgeLineEntityListing.md +3 -3
- data/docs/EmailConversationEntityListing.md +3 -3
- data/docs/EmailMessageListing.md +3 -3
- data/docs/EmergencyGroupListing.md +3 -3
- data/docs/EncryptionKeyEntityListing.md +3 -3
- data/docs/EvaluationAggregationQuery.md +1 -1
- data/docs/EvaluationEntityListing.md +3 -3
- data/docs/EvaluationFormEntityListing.md +3 -3
- data/docs/EvaluatorActivityEntityListing.md +3 -3
- data/docs/ExtensionEntityListing.md +3 -3
- data/docs/ExtensionPoolEntityListing.md +3 -3
- data/docs/ExternalOrganizationListing.md +3 -3
- data/docs/FacebookIntegrationEntityListing.md +3 -3
- data/docs/FaxDocumentEntityListing.md +3 -3
- data/docs/FlowAggregationQuery.md +1 -1
- data/docs/FlowDivisionViewEntityListing.md +3 -3
- data/docs/FlowEntityListing.md +3 -3
- data/docs/FlowOutcomeListing.md +3 -3
- data/docs/FlowVersionEntityListing.md +3 -3
- data/docs/GDPRRequestEntityListing.md +3 -3
- data/docs/GDPRSubjectEntityListing.md +3 -3
- data/docs/GreetingListing.md +3 -3
- data/docs/GroupEntityListing.md +3 -3
- data/docs/GroupProfileEntityListing.md +3 -3
- data/docs/IVREntityListing.md +3 -3
- data/docs/InboundDomainEntityListing.md +3 -3
- data/docs/InboundRouteEntityListing.md +3 -3
- data/docs/IntegrationEntityListing.md +3 -3
- data/docs/IntegrationEventEntityListing.md +3 -3
- data/docs/IntegrationTypeEntityListing.md +3 -3
- data/docs/InteractionStatsAlertContainer.md +3 -3
- data/docs/InteractionStatsRuleContainer.md +3 -3
- data/docs/KeywordSetEntityListing.md +3 -3
- data/docs/LanguageEntityListing.md +3 -3
- data/docs/LexBotAliasEntityListing.md +3 -3
- data/docs/LexBotEntityListing.md +3 -3
- data/docs/LibraryEntityListing.md +3 -3
- data/docs/LineBaseEntityListing.md +3 -3
- data/docs/LineEntityListing.md +3 -3
- data/docs/LineIntegrationEntityListing.md +3 -3
- data/docs/LocationEntityListing.md +3 -3
- data/docs/LogicalInterfaceEntityListing.md +3 -3
- data/docs/ManagementUnitListing.md +3 -3
- data/docs/MessageConversationEntityListing.md +3 -3
- data/docs/MessagingIntegrationEntityListing.md +3 -3
- data/docs/MessagingStickerEntityListing.md +3 -3
- data/docs/NoteListing.md +3 -3
- data/docs/OAuthApi.md +261 -0
- data/docs/OAuthAuthorization.md +20 -0
- data/docs/OAuthAuthorizationListing.md +14 -0
- data/docs/OAuthClientEntityListing.md +3 -3
- data/docs/OAuthProviderEntityListing.md +3 -3
- data/docs/OAuthScope.md +15 -0
- data/docs/OAuthScopeListing.md +14 -0
- data/docs/OrganizationPresenceEntityListing.md +3 -3
- data/docs/OrganizationRoleEntityListing.md +3 -3
- data/docs/OrphanRecordingListing.md +3 -3
- data/docs/OutboundRouteBaseEntityListing.md +3 -3
- data/docs/OutboundRouteEntityListing.md +3 -3
- data/docs/PermissionCollectionEntityListing.md +3 -3
- data/docs/PhoneBaseEntityListing.md +3 -3
- data/docs/PhoneEntityListing.md +3 -3
- data/docs/PhoneMetaBaseEntityListing.md +3 -3
- data/docs/PhysicalInterfaceEntityListing.md +3 -3
- data/docs/PolicyEntityListing.md +3 -3
- data/docs/PromptAssetEntityListing.md +3 -3
- data/docs/PromptEntityListing.md +3 -3
- data/docs/PropertyChange.md +15 -0
- data/docs/QualityAuditPage.md +3 -3
- data/docs/QueueEntityListing.md +3 -3
- data/docs/QueueMemberEntityListing.md +3 -3
- data/docs/QueueUserEventTopicQueueMember.md +4 -4
- data/docs/RecipientListing.md +3 -3
- data/docs/RecordingApi.md +0 -134
- data/docs/RecordingJobEntityListing.md +3 -3
- data/docs/RelationshipListing.md +3 -3
- data/docs/ReportMetaDataEntityListing.md +3 -3
- data/docs/ReportRunEntryEntityDomainListing.md +3 -3
- data/docs/ReportSchedule.md +1 -1
- data/docs/ReportScheduleEntityListing.md +3 -3
- data/docs/ReportingExportJobListing.md +3 -3
- data/docs/ReportingExportJobRequest.md +3 -3
- data/docs/ReportingExportJobResponse.md +3 -3
- data/docs/ResponseEntityList.md +3 -3
- data/docs/ResponseEntityListing.md +3 -3
- data/docs/ResponseSetEntityListing.md +3 -3
- data/docs/RuleSetEntityListing.md +3 -3
- data/docs/Schedule.md +2 -2
- data/docs/ScheduleEntityListing.md +3 -3
- data/docs/ScheduleGroupEntityListing.md +3 -3
- data/docs/SchemaCategoryEntityListing.md +3 -3
- data/docs/SchemaReferenceEntityListing.md +3 -3
- data/docs/ScreenRecordingSessionListing.md +3 -3
- data/docs/ScriptEntityListing.md +3 -3
- data/docs/SecurityProfileEntityListing.md +3 -3
- data/docs/SendAgentlessOutboundMessageRequest.md +1 -1
- data/docs/ShareEntityListing.md +3 -3
- data/docs/SiteEntityListing.md +3 -3
- data/docs/SkillEntityListing.md +3 -3
- data/docs/SmsAddressEntityListing.md +3 -3
- data/docs/SmsPhoneNumberEntityListing.md +3 -3
- data/docs/StationEntityListing.md +3 -3
- data/docs/SubjectDivisionGrantsEntityListing.md +3 -3
- data/docs/SurveyAggregationQuery.md +1 -1
- data/docs/SurveyFormEntityListing.md +3 -3
- data/docs/SystemPromptAssetEntityListing.md +3 -3
- data/docs/SystemPromptEntityListing.md +3 -3
- data/docs/TagValueEntityListing.md +3 -3
- data/docs/TextMessageListing.md +3 -3
- data/docs/TimeZoneEntityListing.md +3 -3
- data/docs/TrunkBaseEntityListing.md +3 -3
- data/docs/TrunkEntityListing.md +3 -3
- data/docs/TrunkMetabaseEntityListing.md +3 -3
- data/docs/TrustEntityListing.md +3 -3
- data/docs/TrustUserEntityListing.md +3 -3
- data/docs/TrustorEntityListing.md +3 -3
- data/docs/TtsEngineEntityListing.md +3 -3
- data/docs/TtsVoiceEntityListing.md +3 -3
- data/docs/TwitterIntegrationEntityListing.md +3 -3
- data/docs/UserActionCategoryEntityListing.md +3 -3
- data/docs/UserAggregationQuery.md +1 -1
- data/docs/UserDetailsQuery.md +1 -1
- data/docs/UserEntityListing.md +3 -3
- data/docs/UserLanguageEntityListing.md +3 -3
- data/docs/UserProfileEntityListing.md +3 -3
- data/docs/UserQueueEntityListing.md +3 -3
- data/docs/UserRecordingEntityListing.md +3 -3
- data/docs/UserSkillEntityListing.md +3 -3
- data/docs/UsersApi.md +267 -0
- data/docs/Utilization.md +1 -1
- data/docs/VoicemailMessageEntityListing.md +3 -3
- data/docs/WebChatMemberInfoEntityList.md +3 -3
- data/docs/WfmBuScheduleQueryResultTopicBuScheduleSearchResultNotification.md +15 -0
- data/docs/WfmBuScheduleRunTopicBuScheduleReference.md +14 -0
- data/docs/WfmBuScheduleRunTopicBuScheduleRun.md +18 -0
- data/docs/WfmBuScheduleRunTopicBuSchedulingRunProgressNotification.md +17 -0
- data/docs/WfmBuScheduleRunTopicLocalDate.md +16 -0
- data/docs/{TimeZone.md → WfmBuScheduleRunTopicUserReference.md} +2 -5
- data/docs/WfmBuScheduleSearchResultTopicBuScheduleSearchResultNotification.md +15 -0
- data/docs/WfmBuScheduleTopicBuManagementUnitScheduleSummary.md +17 -0
- data/docs/WfmBuScheduleTopicBuScheduleGenerationResultSummary.md +15 -0
- data/docs/WfmBuScheduleTopicBuScheduleMetadata.md +21 -0
- data/docs/WfmBuScheduleTopicBuScheduleNotification.md +16 -0
- data/docs/WfmBuScheduleTopicBuShortTermForecastReference.md +15 -0
- data/docs/WfmBuScheduleTopicLocalDate.md +16 -0
- data/docs/{QueueUserEventTopicUserReference.md → WfmBuScheduleTopicManagementUnit.md} +2 -2
- data/docs/WfmBuScheduleTopicUserReference.md +13 -0
- data/docs/WfmBuScheduleTopicWfmVersionedEntityMetadata.md +15 -0
- data/docs/WhatsAppIntegrationEntityListing.md +3 -3
- data/docs/WorkspaceEntityListing.md +3 -3
- data/docs/WorkspaceMemberEntityListing.md +3 -3
- data/docs/WrapupCodeEntityListing.md +3 -3
- data/lib/purecloudplatformclientv2.rb +29 -3
- data/lib/purecloudplatformclientv2/api/analytics_api.rb +268 -0
- data/lib/purecloudplatformclientv2/api/audit_api.rb +240 -0
- data/lib/purecloudplatformclientv2/api/o_auth_api.rb +258 -0
- data/lib/purecloudplatformclientv2/api/recording_api.rb +0 -136
- data/lib/purecloudplatformclientv2/api/users_api.rb +268 -0
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/analytics_user_details_async_query_response.rb +229 -0
- data/lib/purecloudplatformclientv2/models/async_conversation_query.rb +5 -0
- data/lib/purecloudplatformclientv2/models/async_query_status.rb +2 -2
- data/lib/purecloudplatformclientv2/models/async_user_details_query.rb +357 -0
- data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/audit_log_message.rb +536 -0
- data/lib/purecloudplatformclientv2/models/{time_zone.rb → audit_query_execution_results_response.rb} +31 -25
- data/lib/purecloudplatformclientv2/models/audit_query_execution_status_response.rb +362 -0
- data/lib/purecloudplatformclientv2/models/audit_query_filter.rb +252 -0
- data/lib/purecloudplatformclientv2/models/audit_query_request.rb +280 -0
- data/lib/purecloudplatformclientv2/models/authz_division_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/contact_list_division_view_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/contact_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/conversation_aggregation_query.rb +5 -0
- data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/conversation_query.rb +5 -0
- data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/dialogflow_agent_summary_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/dnc_list_division_view_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +24 -24
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +24 -24
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +24 -24
- data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/email_message_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/evaluation_aggregation_query.rb +5 -0
- data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/facebook_integration_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/flow_aggregation_query.rb +5 -0
- data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/flow_outcome_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/greeting_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +24 -24
- data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +24 -24
- data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/lex_bot_alias_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/lex_bot_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/line_integration_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/messaging_integration_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/messaging_sticker_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/note_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/o_auth_authorization.rb +381 -0
- data/lib/purecloudplatformclientv2/models/o_auth_authorization_listing.rb +228 -0
- data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/o_auth_scope.rb +253 -0
- data/lib/purecloudplatformclientv2/models/o_auth_scope_listing.rb +228 -0
- data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/property_change.rb +258 -0
- data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +24 -24
- data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/queue_user_event_topic_queue_member.rb +31 -31
- data/lib/purecloudplatformclientv2/models/recipient_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/recording_job_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/relationship_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/report_schedule.rb +5 -0
- data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/reporting_export_job_request.rb +12 -2
- data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +12 -2
- data/lib/purecloudplatformclientv2/models/response_entity_list.rb +24 -24
- data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/schedule.rb +10 -0
- data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/send_agentless_outbound_message_request.rb +1 -1
- data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/sms_address_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/subject_division_grants_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/survey_aggregation_query.rb +5 -0
- data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/text_message_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/tts_engine_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/tts_voice_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/twitter_integration_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/user_aggregation_query.rb +5 -0
- data/lib/purecloudplatformclientv2/models/user_details_query.rb +5 -0
- data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/utilization.rb +1 -1
- data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/web_chat_member_info_entity_list.rb +24 -24
- data/lib/purecloudplatformclientv2/models/wfm_bu_schedule_query_result_topic_bu_schedule_search_result_notification.rb +251 -0
- data/lib/purecloudplatformclientv2/models/wfm_bu_schedule_run_topic_bu_schedule_reference.rb +226 -0
- data/lib/purecloudplatformclientv2/models/wfm_bu_schedule_run_topic_bu_schedule_run.rb +326 -0
- data/lib/purecloudplatformclientv2/models/wfm_bu_schedule_run_topic_bu_scheduling_run_progress_notification.rb +315 -0
- data/lib/purecloudplatformclientv2/models/wfm_bu_schedule_run_topic_local_date.rb +276 -0
- data/lib/purecloudplatformclientv2/models/{conversation_deletion_protection_query.rb → wfm_bu_schedule_run_topic_user_reference.rb} +8 -16
- data/lib/purecloudplatformclientv2/models/wfm_bu_schedule_search_result_topic_bu_schedule_search_result_notification.rb +251 -0
- data/lib/purecloudplatformclientv2/models/wfm_bu_schedule_topic_bu_management_unit_schedule_summary.rb +303 -0
- data/lib/purecloudplatformclientv2/models/wfm_bu_schedule_topic_bu_schedule_generation_result_summary.rb +251 -0
- data/lib/purecloudplatformclientv2/models/wfm_bu_schedule_topic_bu_schedule_metadata.rb +403 -0
- data/lib/purecloudplatformclientv2/models/wfm_bu_schedule_topic_bu_schedule_notification.rb +304 -0
- data/lib/purecloudplatformclientv2/models/wfm_bu_schedule_topic_bu_short_term_forecast_reference.rb +251 -0
- data/lib/purecloudplatformclientv2/models/wfm_bu_schedule_topic_local_date.rb +276 -0
- data/lib/purecloudplatformclientv2/models/{queue_user_event_topic_user_reference.rb → wfm_bu_schedule_topic_management_unit.rb} +1 -1
- data/lib/purecloudplatformclientv2/models/wfm_bu_schedule_topic_user_reference.rb +201 -0
- data/lib/purecloudplatformclientv2/models/wfm_bu_schedule_topic_wfm_versioned_entity_metadata.rb +251 -0
- data/lib/purecloudplatformclientv2/models/whats_app_integration_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +24 -24
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +60 -8
- data/docs/ConversationDeletionProtectionQuery.md +0 -13
@@ -12,10 +12,10 @@ title: SystemPromptEntityListing
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
|
-
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
15
|
| **previous_uri** | **String** | | [optional] |
|
16
|
+
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **self_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -12,10 +12,10 @@ title: TagValueEntityListing
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
|
-
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
15
|
| **previous_uri** | **String** | | [optional] |
|
16
|
+
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **self_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
data/docs/TextMessageListing.md
CHANGED
@@ -12,10 +12,10 @@ title: TextMessageListing
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
|
-
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
15
|
| **previous_uri** | **String** | | [optional] |
|
16
|
+
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **self_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -12,10 +12,10 @@ title: TimeZoneEntityListing
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
|
-
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
15
|
| **previous_uri** | **String** | | [optional] |
|
16
|
+
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **self_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -12,10 +12,10 @@ title: TrunkBaseEntityListing
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
|
-
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
15
|
| **previous_uri** | **String** | | [optional] |
|
16
|
+
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **self_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
data/docs/TrunkEntityListing.md
CHANGED
@@ -12,10 +12,10 @@ title: TrunkEntityListing
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
|
-
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
15
|
| **previous_uri** | **String** | | [optional] |
|
16
|
+
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **self_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -12,10 +12,10 @@ title: TrunkMetabaseEntityListing
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
|
-
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
15
|
| **previous_uri** | **String** | | [optional] |
|
16
|
+
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **self_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
data/docs/TrustEntityListing.md
CHANGED
@@ -12,10 +12,10 @@ title: TrustEntityListing
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
|
-
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
15
|
| **previous_uri** | **String** | | [optional] |
|
16
|
+
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **self_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -12,10 +12,10 @@ title: TrustUserEntityListing
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
|
-
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
15
|
| **previous_uri** | **String** | | [optional] |
|
16
|
+
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **self_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -12,10 +12,10 @@ title: TrustorEntityListing
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
|
-
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
15
|
| **previous_uri** | **String** | | [optional] |
|
16
|
+
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **self_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -12,10 +12,10 @@ title: TtsEngineEntityListing
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
|
-
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
15
|
| **previous_uri** | **String** | | [optional] |
|
16
|
+
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **self_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -12,10 +12,10 @@ title: TtsVoiceEntityListing
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
|
-
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
15
|
| **previous_uri** | **String** | | [optional] |
|
16
|
+
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **self_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -12,10 +12,10 @@ title: TwitterIntegrationEntityListing
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
|
-
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
15
|
| **previous_uri** | **String** | | [optional] |
|
16
|
+
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **self_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -12,10 +12,10 @@ title: UserActionCategoryEntityListing
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
|
-
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
15
|
| **previous_uri** | **String** | | [optional] |
|
16
|
+
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **self_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -7,7 +7,7 @@ title: UserAggregationQuery
|
|
7
7
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **interval** | **String** | Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss |
|
10
|
+
| **interval** | **String** | Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | |
|
11
11
|
| **granularity** | **String** | Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H | [optional] |
|
12
12
|
| **time_zone** | **String** | Sets the time zone for the query interval, defaults to UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London | [optional] |
|
13
13
|
| **group_by** | **Array<String>** | Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group. | [optional] |
|
data/docs/UserDetailsQuery.md
CHANGED
@@ -7,7 +7,7 @@ title: UserDetailsQuery
|
|
7
7
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **interval** | **String** | Specifies the date and time range of data being queried. Conversations MUST have started within this time range to potentially be included within the result set. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss |
|
10
|
+
| **interval** | **String** | Specifies the date and time range of data being queried. Conversations MUST have started within this time range to potentially be included within the result set. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | |
|
11
11
|
| **user_filters** | [**Array<UserDetailQueryFilter>**](UserDetailQueryFilter.html) | Filters that target the users to retrieve data for | [optional] |
|
12
12
|
| **presence_filters** | [**Array<PresenceDetailQueryFilter>**](PresenceDetailQueryFilter.html) | Filters that target system and organization presence-level data | [optional] |
|
13
13
|
| **routing_status_filters** | [**Array<RoutingStatusDetailQueryFilter>**](RoutingStatusDetailQueryFilter.html) | Filters that target agent routing status-level data | [optional] |
|
data/docs/UserEntityListing.md
CHANGED
@@ -12,10 +12,10 @@ title: UserEntityListing
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
|
-
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
15
|
| **previous_uri** | **String** | | [optional] |
|
16
|
+
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **self_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -12,10 +12,10 @@ title: UserLanguageEntityListing
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
|
-
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
15
|
| **previous_uri** | **String** | | [optional] |
|
16
|
+
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **self_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -12,10 +12,10 @@ title: UserProfileEntityListing
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
|
-
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
15
|
| **previous_uri** | **String** | | [optional] |
|
16
|
+
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **self_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -12,10 +12,10 @@ title: UserQueueEntityListing
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
|
-
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
15
|
| **previous_uri** | **String** | | [optional] |
|
16
|
+
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **self_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -12,10 +12,10 @@ title: UserRecordingEntityListing
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
|
-
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
15
|
| **previous_uri** | **String** | | [optional] |
|
16
|
+
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **self_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -12,10 +12,10 @@ title: UserSkillEntityListing
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
|
-
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
17
|
-
| **last_uri** | **String** | | [optional] |
|
18
15
|
| **previous_uri** | **String** | | [optional] |
|
16
|
+
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **self_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
data/docs/UsersApi.md
CHANGED
@@ -8,6 +8,7 @@ All URIs are relative to *https://api.mypurecloud.com*
|
|
8
8
|
|
9
9
|
Method | Description
|
10
10
|
------------- | ------------- | -------------
|
11
|
+
[**delete_analytics_users_details_job**](UsersApi.html#delete_analytics_users_details_job) | Delete/cancel an async request
|
11
12
|
[**delete_authorization_subject_division_role**](UsersApi.html#delete_authorization_subject_division_role) | Delete a grant of a role in a division
|
12
13
|
[**delete_user**](UsersApi.html#delete_user) | Delete user
|
13
14
|
[**delete_user_roles**](UsersApi.html#delete_user_roles) | Removes all the roles from the user.
|
@@ -15,6 +16,8 @@ Method | Description
|
|
15
16
|
[**delete_user_routingskill**](UsersApi.html#delete_user_routingskill) | Remove routing skill from user
|
16
17
|
[**delete_user_station_associatedstation**](UsersApi.html#delete_user_station_associatedstation) | Clear associated station
|
17
18
|
[**delete_user_station_defaultstation**](UsersApi.html#delete_user_station_defaultstation) | Clear default station
|
19
|
+
[**get_analytics_users_details_job**](UsersApi.html#get_analytics_users_details_job) | Get status for async query for user details
|
20
|
+
[**get_analytics_users_details_job_results**](UsersApi.html#get_analytics_users_details_job_results) | Fetch a page of results for an async query
|
18
21
|
[**get_authorization_divisionspermitted_me**](UsersApi.html#get_authorization_divisionspermitted_me) | Returns whether or not current user can perform the specified action(s).
|
19
22
|
[**get_authorization_divisionspermitted_subject_id**](UsersApi.html#get_authorization_divisionspermitted_subject_id) | Returns whether or not specified user can perform the specified action(s).
|
20
23
|
[**get_authorization_subject**](UsersApi.html#get_authorization_subject) | Returns a listing of roles and permissions for a user.
|
@@ -51,6 +54,7 @@ Method | Description
|
|
51
54
|
[**patch_user_routingskills_bulk**](UsersApi.html#patch_user_routingskills_bulk) | Bulk add routing skills to user
|
52
55
|
[**patch_users_bulk**](UsersApi.html#patch_users_bulk) | Update bulk acd autoanswer on users
|
53
56
|
[**post_analytics_users_aggregates_query**](UsersApi.html#post_analytics_users_aggregates_query) | Query for user aggregates
|
57
|
+
[**post_analytics_users_details_jobs**](UsersApi.html#post_analytics_users_details_jobs) | Query for user details asynchronously
|
54
58
|
[**post_analytics_users_details_query**](UsersApi.html#post_analytics_users_details_query) | Query for user details
|
55
59
|
[**post_analytics_users_observations_query**](UsersApi.html#post_analytics_users_observations_query) | Query for user observations
|
56
60
|
[**post_authorization_subject_bulkadd**](UsersApi.html#post_authorization_subject_bulkadd) | Bulk-grant roles and divisions to a subject.
|
@@ -74,6 +78,70 @@ Method | Description
|
|
74
78
|
[**put_user_station_defaultstation_station_id**](UsersApi.html#put_user_station_defaultstation_station_id) | Set default station
|
75
79
|
{: class="table table-striped"}
|
76
80
|
|
81
|
+
<a name="delete_analytics_users_details_job"></a>
|
82
|
+
|
83
|
+
## delete_analytics_users_details_job(job_id)
|
84
|
+
|
85
|
+
|
86
|
+
|
87
|
+
Delete/cancel an async request
|
88
|
+
|
89
|
+
|
90
|
+
|
91
|
+
Wraps DELETE /api/v2/analytics/users/details/jobs/{jobId}
|
92
|
+
|
93
|
+
Requires ANY permissions:
|
94
|
+
|
95
|
+
* analytics:userDetail:view
|
96
|
+
|
97
|
+
|
98
|
+
### Example
|
99
|
+
```{"language":"ruby"}
|
100
|
+
# load the gem
|
101
|
+
require 'purecloudplatformclientv2'
|
102
|
+
# setup authorization
|
103
|
+
@secret = ENV['PURECLOUD_SECRET']
|
104
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
105
|
+
environment = "mypurecloud.com"
|
106
|
+
|
107
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
108
|
+
|
109
|
+
PureCloud.configure do |config|
|
110
|
+
config.access_token = @authToken
|
111
|
+
end
|
112
|
+
|
113
|
+
api_instance = PureCloud::UsersApi.new
|
114
|
+
|
115
|
+
job_id = "job_id_example" # String | jobId
|
116
|
+
|
117
|
+
|
118
|
+
begin
|
119
|
+
#Delete/cancel an async request
|
120
|
+
api_instance.delete_analytics_users_details_job(job_id)
|
121
|
+
rescue PureCloud::ApiError => e
|
122
|
+
puts "Exception when calling UsersApi->delete_analytics_users_details_job: #{e}"
|
123
|
+
end
|
124
|
+
```
|
125
|
+
|
126
|
+
### Parameters
|
127
|
+
|
128
|
+
Name | Type | Description | Notes
|
129
|
+
------------- | ------------- | ------------- | -------------
|
130
|
+
**job_id** | **String**| jobId | |
|
131
|
+
{: class="table table-striped"}
|
132
|
+
|
133
|
+
|
134
|
+
### Return type
|
135
|
+
|
136
|
+
nil (empty response body)
|
137
|
+
|
138
|
+
### HTTP request headers
|
139
|
+
|
140
|
+
- **Content-Type**: application/json
|
141
|
+
- **Accept**: application/json
|
142
|
+
|
143
|
+
|
144
|
+
|
77
145
|
<a name="delete_authorization_subject_division_role"></a>
|
78
146
|
|
79
147
|
## delete_authorization_subject_division_role(subject_id, division_id, role_id)
|
@@ -536,6 +604,140 @@ nil (empty response body)
|
|
536
604
|
|
537
605
|
|
538
606
|
|
607
|
+
<a name="get_analytics_users_details_job"></a>
|
608
|
+
|
609
|
+
## [**AsyncQueryStatus**](AsyncQueryStatus.html) get_analytics_users_details_job(job_id)
|
610
|
+
|
611
|
+
|
612
|
+
|
613
|
+
Get status for async query for user details
|
614
|
+
|
615
|
+
|
616
|
+
|
617
|
+
Wraps GET /api/v2/analytics/users/details/jobs/{jobId}
|
618
|
+
|
619
|
+
Requires ANY permissions:
|
620
|
+
|
621
|
+
* analytics:userDetail:view
|
622
|
+
|
623
|
+
|
624
|
+
### Example
|
625
|
+
```{"language":"ruby"}
|
626
|
+
# load the gem
|
627
|
+
require 'purecloudplatformclientv2'
|
628
|
+
# setup authorization
|
629
|
+
@secret = ENV['PURECLOUD_SECRET']
|
630
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
631
|
+
environment = "mypurecloud.com"
|
632
|
+
|
633
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
634
|
+
|
635
|
+
PureCloud.configure do |config|
|
636
|
+
config.access_token = @authToken
|
637
|
+
end
|
638
|
+
|
639
|
+
api_instance = PureCloud::UsersApi.new
|
640
|
+
|
641
|
+
job_id = "job_id_example" # String | jobId
|
642
|
+
|
643
|
+
|
644
|
+
begin
|
645
|
+
#Get status for async query for user details
|
646
|
+
result = api_instance.get_analytics_users_details_job(job_id)
|
647
|
+
p result
|
648
|
+
rescue PureCloud::ApiError => e
|
649
|
+
puts "Exception when calling UsersApi->get_analytics_users_details_job: #{e}"
|
650
|
+
end
|
651
|
+
```
|
652
|
+
|
653
|
+
### Parameters
|
654
|
+
|
655
|
+
Name | Type | Description | Notes
|
656
|
+
------------- | ------------- | ------------- | -------------
|
657
|
+
**job_id** | **String**| jobId | |
|
658
|
+
{: class="table table-striped"}
|
659
|
+
|
660
|
+
|
661
|
+
### Return type
|
662
|
+
|
663
|
+
[**AsyncQueryStatus**](AsyncQueryStatus.html)
|
664
|
+
|
665
|
+
### HTTP request headers
|
666
|
+
|
667
|
+
- **Content-Type**: application/json
|
668
|
+
- **Accept**: application/json
|
669
|
+
|
670
|
+
|
671
|
+
|
672
|
+
<a name="get_analytics_users_details_job_results"></a>
|
673
|
+
|
674
|
+
## [**AnalyticsUserDetailsAsyncQueryResponse**](AnalyticsUserDetailsAsyncQueryResponse.html) get_analytics_users_details_job_results(job_id, opts)
|
675
|
+
|
676
|
+
|
677
|
+
|
678
|
+
Fetch a page of results for an async query
|
679
|
+
|
680
|
+
|
681
|
+
|
682
|
+
Wraps GET /api/v2/analytics/users/details/jobs/{jobId}/results
|
683
|
+
|
684
|
+
Requires ANY permissions:
|
685
|
+
|
686
|
+
* analytics:userDetail:view
|
687
|
+
|
688
|
+
|
689
|
+
### Example
|
690
|
+
```{"language":"ruby"}
|
691
|
+
# load the gem
|
692
|
+
require 'purecloudplatformclientv2'
|
693
|
+
# setup authorization
|
694
|
+
@secret = ENV['PURECLOUD_SECRET']
|
695
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
696
|
+
environment = "mypurecloud.com"
|
697
|
+
|
698
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
699
|
+
|
700
|
+
PureCloud.configure do |config|
|
701
|
+
config.access_token = @authToken
|
702
|
+
end
|
703
|
+
|
704
|
+
api_instance = PureCloud::UsersApi.new
|
705
|
+
|
706
|
+
job_id = "job_id_example" # String | jobId
|
707
|
+
|
708
|
+
opts = {
|
709
|
+
cursor: "cursor_example" # String | Indicates where to resume query results (not required for first page)
|
710
|
+
}
|
711
|
+
|
712
|
+
begin
|
713
|
+
#Fetch a page of results for an async query
|
714
|
+
result = api_instance.get_analytics_users_details_job_results(job_id, opts)
|
715
|
+
p result
|
716
|
+
rescue PureCloud::ApiError => e
|
717
|
+
puts "Exception when calling UsersApi->get_analytics_users_details_job_results: #{e}"
|
718
|
+
end
|
719
|
+
```
|
720
|
+
|
721
|
+
### Parameters
|
722
|
+
|
723
|
+
Name | Type | Description | Notes
|
724
|
+
------------- | ------------- | ------------- | -------------
|
725
|
+
**job_id** | **String**| jobId | |
|
726
|
+
**cursor** | **String**| Indicates where to resume query results (not required for first page) | [optional] |
|
727
|
+
{: class="table table-striped"}
|
728
|
+
|
729
|
+
|
730
|
+
### Return type
|
731
|
+
|
732
|
+
[**AnalyticsUserDetailsAsyncQueryResponse**](AnalyticsUserDetailsAsyncQueryResponse.html)
|
733
|
+
|
734
|
+
### HTTP request headers
|
735
|
+
|
736
|
+
- **Content-Type**: application/json
|
737
|
+
- **Accept**: application/json
|
738
|
+
|
739
|
+
|
740
|
+
|
539
741
|
<a name="get_authorization_divisionspermitted_me"></a>
|
540
742
|
|
541
743
|
## [**Array<AuthzDivision>**](AuthzDivision.html) get_authorization_divisionspermitted_me(permission, opts)
|
@@ -2995,6 +3197,71 @@ Name | Type | Description | Notes
|
|
2995
3197
|
|
2996
3198
|
|
2997
3199
|
|
3200
|
+
<a name="post_analytics_users_details_jobs"></a>
|
3201
|
+
|
3202
|
+
## [**AsyncQueryResponse**](AsyncQueryResponse.html) post_analytics_users_details_jobs(body)
|
3203
|
+
|
3204
|
+
|
3205
|
+
|
3206
|
+
Query for user details asynchronously
|
3207
|
+
|
3208
|
+
|
3209
|
+
|
3210
|
+
Wraps POST /api/v2/analytics/users/details/jobs
|
3211
|
+
|
3212
|
+
Requires ANY permissions:
|
3213
|
+
|
3214
|
+
* analytics:userDetail:view
|
3215
|
+
|
3216
|
+
|
3217
|
+
### Example
|
3218
|
+
```{"language":"ruby"}
|
3219
|
+
# load the gem
|
3220
|
+
require 'purecloudplatformclientv2'
|
3221
|
+
# setup authorization
|
3222
|
+
@secret = ENV['PURECLOUD_SECRET']
|
3223
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
3224
|
+
environment = "mypurecloud.com"
|
3225
|
+
|
3226
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
3227
|
+
|
3228
|
+
PureCloud.configure do |config|
|
3229
|
+
config.access_token = @authToken
|
3230
|
+
end
|
3231
|
+
|
3232
|
+
api_instance = PureCloud::UsersApi.new
|
3233
|
+
|
3234
|
+
body = PureCloud::AsyncUserDetailsQuery.new # AsyncUserDetailsQuery | query
|
3235
|
+
|
3236
|
+
|
3237
|
+
begin
|
3238
|
+
#Query for user details asynchronously
|
3239
|
+
result = api_instance.post_analytics_users_details_jobs(body)
|
3240
|
+
p result
|
3241
|
+
rescue PureCloud::ApiError => e
|
3242
|
+
puts "Exception when calling UsersApi->post_analytics_users_details_jobs: #{e}"
|
3243
|
+
end
|
3244
|
+
```
|
3245
|
+
|
3246
|
+
### Parameters
|
3247
|
+
|
3248
|
+
Name | Type | Description | Notes
|
3249
|
+
------------- | ------------- | ------------- | -------------
|
3250
|
+
**body** | [**AsyncUserDetailsQuery**](AsyncUserDetailsQuery.html)| query | |
|
3251
|
+
{: class="table table-striped"}
|
3252
|
+
|
3253
|
+
|
3254
|
+
### Return type
|
3255
|
+
|
3256
|
+
[**AsyncQueryResponse**](AsyncQueryResponse.html)
|
3257
|
+
|
3258
|
+
### HTTP request headers
|
3259
|
+
|
3260
|
+
- **Content-Type**: application/json
|
3261
|
+
- **Accept**: application/json
|
3262
|
+
|
3263
|
+
|
3264
|
+
|
2998
3265
|
<a name="post_analytics_users_details_query"></a>
|
2999
3266
|
|
3000
3267
|
## [**AnalyticsUserDetailsQueryResponse**](AnalyticsUserDetailsQueryResponse.html) post_analytics_users_details_query(body)
|