purecloudplatformclientv2 68.0.0 → 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/ArchitectApi.md +3 -1
- data/docs/AttemptLimitsEntityListing.md +1 -1
- data/docs/AuthzDivisionEntityListing.md +1 -1
- data/docs/CalibrationEntityListing.md +1 -1
- data/docs/CallConversationEntityListing.md +1 -1
- data/docs/CallHistoryConversationEntityListing.md +1 -1
- data/docs/CallMediaParticipant.md +2 -0
- data/docs/CallableTimeSetEntityListing.md +1 -1
- data/docs/CallbackConversationEntityListing.md +1 -1
- data/docs/CallbackMediaParticipant.md +2 -0
- data/docs/CampaignDivisionViewListing.md +1 -1
- data/docs/CampaignEntityListing.md +1 -1
- data/docs/CampaignRuleEntityListing.md +1 -1
- data/docs/CampaignSequenceEntityListing.md +1 -1
- data/docs/CertificateAuthorityEntityListing.md +1 -1
- data/docs/ChatConversationEntityListing.md +1 -1
- data/docs/ChatMediaParticipant.md +2 -0
- data/docs/ClientAppEntityListing.md +1 -1
- data/docs/CobrowseConversationEntityListing.md +1 -1
- data/docs/CobrowseMediaParticipant.md +2 -0
- data/docs/CommandStatusEntityListing.md +1 -1
- data/docs/ConsumedResourcesEntityListing.md +1 -1
- data/docs/ConsumingResourcesEntityListing.md +1 -1
- data/docs/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/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/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/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/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/IntegrationTypeEntityListing.md +1 -1
- data/docs/InteractionStatsAlertContainer.md +1 -1
- data/docs/InteractionStatsRuleContainer.md +1 -1
- data/docs/KeywordSetEntityListing.md +1 -1
- data/docs/LanguageEntityListing.md +1 -1
- data/docs/LexBotAliasEntityListing.md +1 -1
- data/docs/LexBotEntityListing.md +1 -1
- data/docs/LibraryEntityListing.md +1 -1
- data/docs/LineBaseEntityListing.md +1 -1
- data/docs/LineEntityListing.md +1 -1
- data/docs/LineIntegrationEntityListing.md +1 -1
- data/docs/{LocationCreateUpdateDefinition.md → LocationCreateDefinition.md} +3 -4
- data/docs/LocationEntityListing.md +1 -1
- data/docs/LocationUpdateDefinition.md +20 -0
- data/docs/LocationsApi.md +4 -4
- data/docs/LogicalInterfaceEntityListing.md +1 -1
- data/docs/ManagementUnitListing.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/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/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/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/RecordingApi.md +164 -14
- data/docs/RecordingJobEntityListing.md +1 -1
- 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 +1 -0
- data/docs/ReportingExportJobResponse.md +1 -0
- data/docs/ResponseEntityList.md +1 -1
- data/docs/ResponseEntityListing.md +1 -1
- data/docs/ResponseSetEntityListing.md +1 -1
- data/docs/RoutingApi.md +0 -2
- data/docs/RuleSetEntityListing.md +1 -1
- data/docs/ScheduleEntityListing.md +1 -1
- data/docs/ScheduleGroupEntityListing.md +1 -1
- data/docs/SchemaCategoryEntityListing.md +1 -1
- data/docs/SchemaReferenceEntityListing.md +1 -1
- data/docs/ScimConfigResourceTypeSchemaExtension.md +1 -1
- data/docs/ScimServiceProviderConfig.md +6 -6
- data/docs/ScreenRecordingSessionListing.md +1 -1
- data/docs/ScriptEntityListing.md +1 -1
- data/docs/SecurityProfileEntityListing.md +1 -1
- data/docs/SelectedColumns.md +14 -0
- data/docs/ShareEntityListing.md +1 -1
- 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/SurveyAggregationQuery.md +1 -0
- data/docs/SurveyFormEntityListing.md +1 -1
- data/docs/SystemPromptAssetEntityListing.md +1 -1
- data/docs/SystemPromptEntityListing.md +1 -1
- data/docs/TagValueEntityListing.md +1 -1
- data/docs/TextMessageListing.md +1 -1
- data/docs/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/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/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 +0 -345
- data/docs/VoicemailMessageEntityListing.md +1 -1
- data/docs/WebChatMemberInfoEntityList.md +1 -1
- data/docs/WebChatMessageEntityList.md +1 -1
- data/docs/WhatsAppIntegrationEntityListing.md +1 -1
- data/docs/WorkspaceEntityListing.md +1 -1
- data/docs/WorkspaceMemberEntityListing.md +1 -1
- data/docs/WrapupCodeEntityListing.md +1 -1
- data/lib/purecloudplatformclientv2.rb +6 -2
- data/lib/purecloudplatformclientv2/api/architect_api.rb +9 -0
- 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/users_api.rb +0 -383
- 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/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_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_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/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_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_aggregation_query.rb +2 -2
- data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/evaluation_question.rb +13 -13
- data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +12 -12
- 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_aggregation_query.rb +44 -4
- data/lib/purecloudplatformclientv2/models/flow_division_view.rb +53 -1
- data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_outcome_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/greeting_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +12 -12
- data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +12 -12
- data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/lex_bot_alias_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/lex_bot_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/line_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/location_create_definition.rb +405 -0
- data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/{location_create_update_definition.rb → location_update_definition.rb} +8 -28
- 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/message_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/{user_external_identifier.rb → message_evaluation.rb} +44 -32
- 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/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_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_job_entity_listing.rb +12 -12
- 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_export_job_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/reporting_export_job_request.rb +32 -4
- data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +29 -1
- data/lib/purecloudplatformclientv2/models/response_entity_list.rb +12 -12
- data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/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/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_schema_extension.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_service_provider_config.rb +6 -6
- 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/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_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/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_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_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/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 +14 -6
- data/docs/UserExternalIdentifier.md +0 -15
@@ -11,8 +11,8 @@ title: VoicemailMessageEntityListing
|
|
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: WebChatMemberInfoEntityList
|
|
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] |
|
@@ -10,8 +10,8 @@ title: WebChatMessageEntityList
|
|
10
10
|
| **page_size** | **Integer** | | [optional] |
|
11
11
|
| **entities** | [**Array<WebChatMessage>**](WebChatMessage.html) | | [optional] |
|
12
12
|
| **previous_page** | **String** | | [optional] |
|
13
|
-
| **_next** | **String** | | [optional] |
|
14
13
|
| **self_uri** | **String** | | [optional] |
|
14
|
+
| **_next** | **String** | | [optional] |
|
15
15
|
{: class="table table-striped"}
|
16
16
|
|
17
17
|
|
@@ -11,8 +11,8 @@ title: WhatsAppIntegrationEntityListing
|
|
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: WorkspaceEntityListing
|
|
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: WorkspaceMemberEntityListing
|
|
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: WrapupCodeEntityListing
|
|
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] |
|
@@ -347,6 +347,7 @@ require 'purecloudplatformclientv2/models/conversation_cobrowse_event_topic_jour
|
|
347
347
|
require 'purecloudplatformclientv2/models/conversation_cobrowse_event_topic_scored_agent'
|
348
348
|
require 'purecloudplatformclientv2/models/conversation_cobrowse_event_topic_uri_reference'
|
349
349
|
require 'purecloudplatformclientv2/models/conversation_cobrowse_event_topic_wrapup'
|
350
|
+
require 'purecloudplatformclientv2/models/conversation_deletion_protection_query'
|
350
351
|
require 'purecloudplatformclientv2/models/conversation_detail_query_clause'
|
351
352
|
require 'purecloudplatformclientv2/models/conversation_detail_query_filter'
|
352
353
|
require 'purecloudplatformclientv2/models/conversation_detail_query_predicate'
|
@@ -925,13 +926,14 @@ require 'purecloudplatformclientv2/models/local_encryption_key_request'
|
|
925
926
|
require 'purecloudplatformclientv2/models/location'
|
926
927
|
require 'purecloudplatformclientv2/models/location_address'
|
927
928
|
require 'purecloudplatformclientv2/models/location_address_verification_details'
|
928
|
-
require 'purecloudplatformclientv2/models/
|
929
|
+
require 'purecloudplatformclientv2/models/location_create_definition'
|
929
930
|
require 'purecloudplatformclientv2/models/location_definition'
|
930
931
|
require 'purecloudplatformclientv2/models/location_emergency_number'
|
931
932
|
require 'purecloudplatformclientv2/models/location_entity_listing'
|
932
933
|
require 'purecloudplatformclientv2/models/location_image'
|
933
934
|
require 'purecloudplatformclientv2/models/location_search_criteria'
|
934
935
|
require 'purecloudplatformclientv2/models/location_search_request'
|
936
|
+
require 'purecloudplatformclientv2/models/location_update_definition'
|
935
937
|
require 'purecloudplatformclientv2/models/locations_search_response'
|
936
938
|
require 'purecloudplatformclientv2/models/lock_info'
|
937
939
|
require 'purecloudplatformclientv2/models/logical_interface_entity_listing'
|
@@ -956,6 +958,7 @@ require 'purecloudplatformclientv2/models/message_conversation'
|
|
956
958
|
require 'purecloudplatformclientv2/models/message_conversation_entity_listing'
|
957
959
|
require 'purecloudplatformclientv2/models/message_data'
|
958
960
|
require 'purecloudplatformclientv2/models/message_details'
|
961
|
+
require 'purecloudplatformclientv2/models/message_evaluation'
|
959
962
|
require 'purecloudplatformclientv2/models/message_info'
|
960
963
|
require 'purecloudplatformclientv2/models/message_media'
|
961
964
|
require 'purecloudplatformclientv2/models/message_media_attachment'
|
@@ -1289,6 +1292,7 @@ require 'purecloudplatformclientv2/models/queue_observation_query_response'
|
|
1289
1292
|
require 'purecloudplatformclientv2/models/queue_reference'
|
1290
1293
|
require 'purecloudplatformclientv2/models/queue_request'
|
1291
1294
|
require 'purecloudplatformclientv2/models/queue_user_event_topic_queue_member'
|
1295
|
+
require 'purecloudplatformclientv2/models/queue_user_event_topic_user_reference'
|
1292
1296
|
require 'purecloudplatformclientv2/models/queue_utilization_diagnostic'
|
1293
1297
|
require 'purecloudplatformclientv2/models/reaction'
|
1294
1298
|
require 'purecloudplatformclientv2/models/recall_entry'
|
@@ -1418,6 +1422,7 @@ require 'purecloudplatformclientv2/models/segment'
|
|
1418
1422
|
require 'purecloudplatformclientv2/models/segment_detail_query_clause'
|
1419
1423
|
require 'purecloudplatformclientv2/models/segment_detail_query_filter'
|
1420
1424
|
require 'purecloudplatformclientv2/models/segment_detail_query_predicate'
|
1425
|
+
require 'purecloudplatformclientv2/models/selected_columns'
|
1421
1426
|
require 'purecloudplatformclientv2/models/sequence_schedule'
|
1422
1427
|
require 'purecloudplatformclientv2/models/server_date'
|
1423
1428
|
require 'purecloudplatformclientv2/models/service_context'
|
@@ -1617,7 +1622,6 @@ require 'purecloudplatformclientv2/models/user_details_query'
|
|
1617
1622
|
require 'purecloudplatformclientv2/models/user_device'
|
1618
1623
|
require 'purecloudplatformclientv2/models/user_entity_listing'
|
1619
1624
|
require 'purecloudplatformclientv2/models/user_expands'
|
1620
|
-
require 'purecloudplatformclientv2/models/user_external_identifier'
|
1621
1625
|
require 'purecloudplatformclientv2/models/user_greeting_event_greeting'
|
1622
1626
|
require 'purecloudplatformclientv2/models/user_greeting_event_greeting_audio_file'
|
1623
1627
|
require 'purecloudplatformclientv2/models/user_greeting_event_greeting_owner'
|
@@ -4583,6 +4583,7 @@ module PureCloud
|
|
4583
4583
|
# @option opts [String] :published_after Published after
|
4584
4584
|
# @option opts [String] :published_before Published before
|
4585
4585
|
# @option opts [Array<String>] :division_id division ID(s)
|
4586
|
+
# @option opts [BOOLEAN] :include_schemas Include variable schemas (default to false)
|
4586
4587
|
# @return [FlowDivisionViewEntityListing]
|
4587
4588
|
def get_flows_divisionviews(opts = {})
|
4588
4589
|
data, _status_code, _headers = get_flows_divisionviews_with_http_info(opts)
|
@@ -4603,6 +4604,7 @@ module PureCloud
|
|
4603
4604
|
# @option opts [String] :published_after Published after
|
4604
4605
|
# @option opts [String] :published_before Published before
|
4605
4606
|
# @option opts [Array<String>] :division_id division ID(s)
|
4607
|
+
# @option opts [BOOLEAN] :include_schemas Include variable schemas
|
4606
4608
|
# @return [Array<(FlowDivisionViewEntityListing, Fixnum, Hash)>] FlowDivisionViewEntityListing data, response status code and response headers
|
4607
4609
|
def get_flows_divisionviews_with_http_info(opts = {})
|
4608
4610
|
if @api_client.config.debugging
|
@@ -4668,6 +4670,12 @@ module PureCloud
|
|
4668
4670
|
|
4669
4671
|
|
4670
4672
|
|
4673
|
+
|
4674
|
+
|
4675
|
+
|
4676
|
+
|
4677
|
+
|
4678
|
+
|
4671
4679
|
|
4672
4680
|
|
4673
4681
|
|
@@ -4691,6 +4699,7 @@ module PureCloud
|
|
4691
4699
|
query_params[:'publishedAfter'] = opts[:'published_after'] if opts[:'published_after']
|
4692
4700
|
query_params[:'publishedBefore'] = opts[:'published_before'] if opts[:'published_before']
|
4693
4701
|
query_params[:'divisionId'] = @api_client.build_collection_param(opts[:'division_id'], :multi) if opts[:'division_id']
|
4702
|
+
query_params[:'includeSchemas'] = opts[:'include_schemas'] if opts[:'include_schemas']
|
4694
4703
|
|
4695
4704
|
# header parameters
|
4696
4705
|
header_params = {}
|
@@ -899,7 +899,7 @@ module PureCloud
|
|
899
899
|
end
|
900
900
|
|
901
901
|
# Get audits for conversation or recording
|
902
|
-
#
|
902
|
+
# Different permissions are required for viewing different resource audit entries. The quality:evaluation:viewAudit permission is required to view evaluation audits, the recording:recording:viewAudit permission is required to view recording audits, and so on.
|
903
903
|
# @param conversation_id Conversation ID
|
904
904
|
# @param [Hash] opts the optional parameters
|
905
905
|
# @option opts [Integer] :page_size The total page size requested (default to 25)
|
@@ -917,7 +917,7 @@ module PureCloud
|
|
917
917
|
end
|
918
918
|
|
919
919
|
# Get audits for conversation or recording
|
920
|
-
#
|
920
|
+
# Different permissions are required for viewing different resource audit entries. The quality:evaluation:viewAudit permission is required to view evaluation audits, the recording:recording:viewAudit permission is required to view recording audits, and so on.
|
921
921
|
# @param conversation_id Conversation ID
|
922
922
|
# @param [Hash] opts the optional parameters
|
923
923
|
# @option opts [Integer] :page_size The total page size requested
|
@@ -4428,7 +4428,7 @@ module PureCloud
|
|
4428
4428
|
end
|
4429
4429
|
|
4430
4430
|
# Update an evaluation
|
4431
|
-
#
|
4431
|
+
# The quality:evaluation:edit permission allows modification of most fields, while the quality:evaluation:editScore permission allows an evaluator to change just the question scores, and the quality:evaluation:editAgentSignoff permission allows an agent to change the agent comments and sign off on the evaluation.
|
4432
4432
|
# @param conversation_id conversationId
|
4433
4433
|
# @param evaluation_id evaluationId
|
4434
4434
|
# @param body evaluation
|
@@ -4441,7 +4441,7 @@ module PureCloud
|
|
4441
4441
|
end
|
4442
4442
|
|
4443
4443
|
# Update an evaluation
|
4444
|
-
#
|
4444
|
+
# The quality:evaluation:edit permission allows modification of most fields, while the quality:evaluation:editScore permission allows an evaluator to change just the question scores, and the quality:evaluation:editAgentSignoff permission allows an agent to change the agent comments and sign off on the evaluation.
|
4445
4445
|
# @param conversation_id conversationId
|
4446
4446
|
# @param evaluation_id evaluationId
|
4447
4447
|
# @param body evaluation
|
@@ -2609,8 +2609,73 @@ module PureCloud
|
|
2609
2609
|
return data, status_code, headers
|
2610
2610
|
end
|
2611
2611
|
|
2612
|
+
# Get a list of conversations with protected recordings
|
2613
|
+
#
|
2614
|
+
# @param body conversationIds
|
2615
|
+
# @param [Hash] opts the optional parameters
|
2616
|
+
# @return [Array<AddressableEntityRef>]
|
2617
|
+
def post_recordings_deletionprotection(body, opts = {})
|
2618
|
+
data, _status_code, _headers = post_recordings_deletionprotection_with_http_info(body, opts)
|
2619
|
+
return data
|
2620
|
+
end
|
2621
|
+
|
2622
|
+
# Get a list of conversations with protected recordings
|
2623
|
+
#
|
2624
|
+
# @param body conversationIds
|
2625
|
+
# @param [Hash] opts the optional parameters
|
2626
|
+
# @return [Array<(Array<AddressableEntityRef>, Fixnum, Hash)>] Array<AddressableEntityRef> data, response status code and response headers
|
2627
|
+
def post_recordings_deletionprotection_with_http_info(body, opts = {})
|
2628
|
+
if @api_client.config.debugging
|
2629
|
+
@api_client.config.logger.debug "Calling API: RecordingApi.post_recordings_deletionprotection ..."
|
2630
|
+
end
|
2631
|
+
|
2632
|
+
|
2633
|
+
# verify the required parameter 'body' is set
|
2634
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling RecordingApi.post_recordings_deletionprotection" if body.nil?
|
2635
|
+
|
2636
|
+
|
2637
|
+
|
2638
|
+
|
2639
|
+
|
2640
|
+
# resource path
|
2641
|
+
local_var_path = "/api/v2/recordings/deletionprotection".sub('{format}','json')
|
2642
|
+
|
2643
|
+
# query parameters
|
2644
|
+
query_params = {}
|
2645
|
+
|
2646
|
+
# header parameters
|
2647
|
+
header_params = {}
|
2648
|
+
|
2649
|
+
# HTTP header 'Accept' (if needed)
|
2650
|
+
local_header_accept = ['application/json']
|
2651
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
2652
|
+
|
2653
|
+
# HTTP header 'Content-Type'
|
2654
|
+
local_header_content_type = ['application/json']
|
2655
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
2656
|
+
|
2657
|
+
# form parameters
|
2658
|
+
form_params = {}
|
2659
|
+
|
2660
|
+
# http body (model)
|
2661
|
+
post_body = @api_client.object_to_http_body(body)
|
2662
|
+
|
2663
|
+
auth_names = ['PureCloud OAuth']
|
2664
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
2665
|
+
:header_params => header_params,
|
2666
|
+
:query_params => query_params,
|
2667
|
+
:form_params => form_params,
|
2668
|
+
:body => post_body,
|
2669
|
+
:auth_names => auth_names,
|
2670
|
+
:return_type => 'Array<AddressableEntityRef>')
|
2671
|
+
if @api_client.config.debugging
|
2672
|
+
@api_client.config.logger.debug "API called: RecordingApi#post_recordings_deletionprotection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2673
|
+
end
|
2674
|
+
return data, status_code, headers
|
2675
|
+
end
|
2676
|
+
|
2612
2677
|
# Updates the retention records on a recording.
|
2613
|
-
# 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.
|
2678
|
+
# 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.
|
2614
2679
|
# @param conversation_id Conversation ID
|
2615
2680
|
# @param recording_id Recording ID
|
2616
2681
|
# @param body recording
|
@@ -2622,7 +2687,7 @@ module PureCloud
|
|
2622
2687
|
end
|
2623
2688
|
|
2624
2689
|
# Updates the retention records on a recording.
|
2625
|
-
# 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.
|
2690
|
+
# 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.
|
2626
2691
|
# @param conversation_id Conversation ID
|
2627
2692
|
# @param recording_id Recording ID
|
2628
2693
|
# @param body recording
|
@@ -3216,5 +3281,76 @@ module PureCloud
|
|
3216
3281
|
end
|
3217
3282
|
return data, status_code, headers
|
3218
3283
|
end
|
3284
|
+
|
3285
|
+
# Apply or revoke recording protection for conversations
|
3286
|
+
#
|
3287
|
+
# @param [Hash] opts the optional parameters
|
3288
|
+
# @option opts [BOOLEAN] :protect Check for apply, uncheck for revoke (each action requires the respective permission) (default to true)
|
3289
|
+
# @option opts [ConversationDeletionProtectionQuery] :body
|
3290
|
+
# @return [nil]
|
3291
|
+
def put_recordings_deletionprotection(opts = {})
|
3292
|
+
put_recordings_deletionprotection_with_http_info(opts)
|
3293
|
+
return nil
|
3294
|
+
end
|
3295
|
+
|
3296
|
+
# Apply or revoke recording protection for conversations
|
3297
|
+
#
|
3298
|
+
# @param [Hash] opts the optional parameters
|
3299
|
+
# @option opts [BOOLEAN] :protect Check for apply, uncheck for revoke (each action requires the respective permission)
|
3300
|
+
# @option opts [ConversationDeletionProtectionQuery] :body
|
3301
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
3302
|
+
def put_recordings_deletionprotection_with_http_info(opts = {})
|
3303
|
+
if @api_client.config.debugging
|
3304
|
+
@api_client.config.logger.debug "Calling API: RecordingApi.put_recordings_deletionprotection ..."
|
3305
|
+
end
|
3306
|
+
|
3307
|
+
|
3308
|
+
|
3309
|
+
|
3310
|
+
|
3311
|
+
|
3312
|
+
|
3313
|
+
|
3314
|
+
|
3315
|
+
|
3316
|
+
|
3317
|
+
|
3318
|
+
|
3319
|
+
# resource path
|
3320
|
+
local_var_path = "/api/v2/recordings/deletionprotection".sub('{format}','json')
|
3321
|
+
|
3322
|
+
# query parameters
|
3323
|
+
query_params = {}
|
3324
|
+
query_params[:'protect'] = opts[:'protect'] if opts[:'protect']
|
3325
|
+
|
3326
|
+
# header parameters
|
3327
|
+
header_params = {}
|
3328
|
+
|
3329
|
+
# HTTP header 'Accept' (if needed)
|
3330
|
+
local_header_accept = ['application/json']
|
3331
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
3332
|
+
|
3333
|
+
# HTTP header 'Content-Type'
|
3334
|
+
local_header_content_type = ['application/json']
|
3335
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
3336
|
+
|
3337
|
+
# form parameters
|
3338
|
+
form_params = {}
|
3339
|
+
|
3340
|
+
# http body (model)
|
3341
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
3342
|
+
|
3343
|
+
auth_names = ['PureCloud OAuth']
|
3344
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
3345
|
+
:header_params => header_params,
|
3346
|
+
:query_params => query_params,
|
3347
|
+
:form_params => form_params,
|
3348
|
+
:body => post_body,
|
3349
|
+
:auth_names => auth_names)
|
3350
|
+
if @api_client.config.debugging
|
3351
|
+
@api_client.config.logger.debug "API called: RecordingApi#put_recordings_deletionprotection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3352
|
+
end
|
3353
|
+
return data, status_code, headers
|
3354
|
+
end
|
3219
3355
|
end
|
3220
3356
|
end
|
@@ -1842,7 +1842,6 @@ module PureCloud
|
|
1842
1842
|
# @option opts [Integer] :page_number Page number (default to 1)
|
1843
1843
|
# @option opts [String] :sort_by Sort by (default to name)
|
1844
1844
|
# @option opts [String] :name Name
|
1845
|
-
# @option opts [BOOLEAN] :active Active
|
1846
1845
|
# @option opts [Array<String>] :id ID(s)
|
1847
1846
|
# @option opts [Array<String>] :division_id Division ID(s)
|
1848
1847
|
# @return [QueueEntityListing]
|
@@ -1858,7 +1857,6 @@ module PureCloud
|
|
1858
1857
|
# @option opts [Integer] :page_number Page number
|
1859
1858
|
# @option opts [String] :sort_by Sort by
|
1860
1859
|
# @option opts [String] :name Name
|
1861
|
-
# @option opts [BOOLEAN] :active Active
|
1862
1860
|
# @option opts [Array<String>] :id ID(s)
|
1863
1861
|
# @option opts [Array<String>] :division_id Division ID(s)
|
1864
1862
|
# @return [Array<(QueueEntityListing, Fixnum, Hash)>] QueueEntityListing data, response status code and response headers
|
@@ -1896,12 +1894,6 @@ module PureCloud
|
|
1896
1894
|
|
1897
1895
|
|
1898
1896
|
|
1899
|
-
|
1900
|
-
|
1901
|
-
|
1902
|
-
|
1903
|
-
|
1904
|
-
|
1905
1897
|
|
1906
1898
|
|
1907
1899
|
|
@@ -1918,7 +1910,6 @@ module PureCloud
|
|
1918
1910
|
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
|
1919
1911
|
query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
|
1920
1912
|
query_params[:'name'] = opts[:'name'] if opts[:'name']
|
1921
|
-
query_params[:'active'] = opts[:'active'] if opts[:'active']
|
1922
1913
|
query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
|
1923
1914
|
query_params[:'divisionId'] = @api_client.build_collection_param(opts[:'division_id'], :multi) if opts[:'division_id']
|
1924
1915
|
|
@@ -173,90 +173,6 @@ module PureCloud
|
|
173
173
|
return data, status_code, headers
|
174
174
|
end
|
175
175
|
|
176
|
-
# Delete the external identifier for user.
|
177
|
-
#
|
178
|
-
# @param user_id User ID
|
179
|
-
# @param authority_name Authority Name
|
180
|
-
# @param external_key External Key
|
181
|
-
# @param [Hash] opts the optional parameters
|
182
|
-
# @return [nil]
|
183
|
-
def delete_user_externalid_authority_name_external_key(user_id, authority_name, external_key, opts = {})
|
184
|
-
delete_user_externalid_authority_name_external_key_with_http_info(user_id, authority_name, external_key, opts)
|
185
|
-
return nil
|
186
|
-
end
|
187
|
-
|
188
|
-
# Delete the external identifier for user.
|
189
|
-
#
|
190
|
-
# @param user_id User ID
|
191
|
-
# @param authority_name Authority Name
|
192
|
-
# @param external_key External Key
|
193
|
-
# @param [Hash] opts the optional parameters
|
194
|
-
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
195
|
-
def delete_user_externalid_authority_name_external_key_with_http_info(user_id, authority_name, external_key, opts = {})
|
196
|
-
if @api_client.config.debugging
|
197
|
-
@api_client.config.logger.debug "Calling API: UsersApi.delete_user_externalid_authority_name_external_key ..."
|
198
|
-
end
|
199
|
-
|
200
|
-
|
201
|
-
# verify the required parameter 'user_id' is set
|
202
|
-
fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.delete_user_externalid_authority_name_external_key" if user_id.nil?
|
203
|
-
|
204
|
-
|
205
|
-
|
206
|
-
|
207
|
-
|
208
|
-
|
209
|
-
# verify the required parameter 'authority_name' is set
|
210
|
-
fail ArgumentError, "Missing the required parameter 'authority_name' when calling UsersApi.delete_user_externalid_authority_name_external_key" if authority_name.nil?
|
211
|
-
|
212
|
-
|
213
|
-
|
214
|
-
|
215
|
-
|
216
|
-
|
217
|
-
# verify the required parameter 'external_key' is set
|
218
|
-
fail ArgumentError, "Missing the required parameter 'external_key' when calling UsersApi.delete_user_externalid_authority_name_external_key" if external_key.nil?
|
219
|
-
|
220
|
-
|
221
|
-
|
222
|
-
|
223
|
-
|
224
|
-
# resource path
|
225
|
-
local_var_path = "/api/v2/users/{userId}/externalid/{authorityName}/{externalKey}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'authorityName' + '}', authority_name.to_s).sub('{' + 'externalKey' + '}', external_key.to_s)
|
226
|
-
|
227
|
-
# query parameters
|
228
|
-
query_params = {}
|
229
|
-
|
230
|
-
# header parameters
|
231
|
-
header_params = {}
|
232
|
-
|
233
|
-
# HTTP header 'Accept' (if needed)
|
234
|
-
local_header_accept = ['application/json']
|
235
|
-
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
236
|
-
|
237
|
-
# HTTP header 'Content-Type'
|
238
|
-
local_header_content_type = ['application/json']
|
239
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
240
|
-
|
241
|
-
# form parameters
|
242
|
-
form_params = {}
|
243
|
-
|
244
|
-
# http body (model)
|
245
|
-
post_body = nil
|
246
|
-
|
247
|
-
auth_names = ['PureCloud OAuth']
|
248
|
-
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
249
|
-
:header_params => header_params,
|
250
|
-
:query_params => query_params,
|
251
|
-
:form_params => form_params,
|
252
|
-
:body => post_body,
|
253
|
-
:auth_names => auth_names)
|
254
|
-
if @api_client.config.debugging
|
255
|
-
@api_client.config.logger.debug "API called: UsersApi#delete_user_externalid_authority_name_external_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
256
|
-
end
|
257
|
-
return data, status_code, headers
|
258
|
-
end
|
259
|
-
|
260
176
|
# Removes all the roles from the user.
|
261
177
|
#
|
262
178
|
# @param user_id User ID
|
@@ -1361,146 +1277,6 @@ module PureCloud
|
|
1361
1277
|
return data, status_code, headers
|
1362
1278
|
end
|
1363
1279
|
|
1364
|
-
# Get the external identifiers for a user.
|
1365
|
-
#
|
1366
|
-
# @param user_id User ID
|
1367
|
-
# @param [Hash] opts the optional parameters
|
1368
|
-
# @return [Array<UserExternalIdentifier>]
|
1369
|
-
def get_user_externalid(user_id, opts = {})
|
1370
|
-
data, _status_code, _headers = get_user_externalid_with_http_info(user_id, opts)
|
1371
|
-
return data
|
1372
|
-
end
|
1373
|
-
|
1374
|
-
# Get the external identifiers for a user.
|
1375
|
-
#
|
1376
|
-
# @param user_id User ID
|
1377
|
-
# @param [Hash] opts the optional parameters
|
1378
|
-
# @return [Array<(Array<UserExternalIdentifier>, Fixnum, Hash)>] Array<UserExternalIdentifier> data, response status code and response headers
|
1379
|
-
def get_user_externalid_with_http_info(user_id, opts = {})
|
1380
|
-
if @api_client.config.debugging
|
1381
|
-
@api_client.config.logger.debug "Calling API: UsersApi.get_user_externalid ..."
|
1382
|
-
end
|
1383
|
-
|
1384
|
-
|
1385
|
-
# verify the required parameter 'user_id' is set
|
1386
|
-
fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_user_externalid" if user_id.nil?
|
1387
|
-
|
1388
|
-
|
1389
|
-
|
1390
|
-
|
1391
|
-
|
1392
|
-
# resource path
|
1393
|
-
local_var_path = "/api/v2/users/{userId}/externalid".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
|
1394
|
-
|
1395
|
-
# query parameters
|
1396
|
-
query_params = {}
|
1397
|
-
|
1398
|
-
# header parameters
|
1399
|
-
header_params = {}
|
1400
|
-
|
1401
|
-
# HTTP header 'Accept' (if needed)
|
1402
|
-
local_header_accept = ['application/json']
|
1403
|
-
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
1404
|
-
|
1405
|
-
# HTTP header 'Content-Type'
|
1406
|
-
local_header_content_type = ['application/json']
|
1407
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
1408
|
-
|
1409
|
-
# form parameters
|
1410
|
-
form_params = {}
|
1411
|
-
|
1412
|
-
# http body (model)
|
1413
|
-
post_body = nil
|
1414
|
-
|
1415
|
-
auth_names = ['PureCloud OAuth']
|
1416
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1417
|
-
:header_params => header_params,
|
1418
|
-
:query_params => query_params,
|
1419
|
-
:form_params => form_params,
|
1420
|
-
:body => post_body,
|
1421
|
-
:auth_names => auth_names,
|
1422
|
-
:return_type => 'Array<UserExternalIdentifier>')
|
1423
|
-
if @api_client.config.debugging
|
1424
|
-
@api_client.config.logger.debug "API called: UsersApi#get_user_externalid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1425
|
-
end
|
1426
|
-
return data, status_code, headers
|
1427
|
-
end
|
1428
|
-
|
1429
|
-
# Get the external identifier of user for an authority.
|
1430
|
-
# Authority name and external key are case sensitive.
|
1431
|
-
# @param user_id User ID
|
1432
|
-
# @param authority_name Authority Name
|
1433
|
-
# @param [Hash] opts the optional parameters
|
1434
|
-
# @return [UserExternalIdentifier]
|
1435
|
-
def get_user_externalid_authority_name(user_id, authority_name, opts = {})
|
1436
|
-
data, _status_code, _headers = get_user_externalid_authority_name_with_http_info(user_id, authority_name, opts)
|
1437
|
-
return data
|
1438
|
-
end
|
1439
|
-
|
1440
|
-
# Get the external identifier of user for an authority.
|
1441
|
-
# Authority name and external key are case sensitive.
|
1442
|
-
# @param user_id User ID
|
1443
|
-
# @param authority_name Authority Name
|
1444
|
-
# @param [Hash] opts the optional parameters
|
1445
|
-
# @return [Array<(UserExternalIdentifier, Fixnum, Hash)>] UserExternalIdentifier data, response status code and response headers
|
1446
|
-
def get_user_externalid_authority_name_with_http_info(user_id, authority_name, opts = {})
|
1447
|
-
if @api_client.config.debugging
|
1448
|
-
@api_client.config.logger.debug "Calling API: UsersApi.get_user_externalid_authority_name ..."
|
1449
|
-
end
|
1450
|
-
|
1451
|
-
|
1452
|
-
# verify the required parameter 'user_id' is set
|
1453
|
-
fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_user_externalid_authority_name" if user_id.nil?
|
1454
|
-
|
1455
|
-
|
1456
|
-
|
1457
|
-
|
1458
|
-
|
1459
|
-
|
1460
|
-
# verify the required parameter 'authority_name' is set
|
1461
|
-
fail ArgumentError, "Missing the required parameter 'authority_name' when calling UsersApi.get_user_externalid_authority_name" if authority_name.nil?
|
1462
|
-
|
1463
|
-
|
1464
|
-
|
1465
|
-
|
1466
|
-
|
1467
|
-
# resource path
|
1468
|
-
local_var_path = "/api/v2/users/{userId}/externalid/{authorityName}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'authorityName' + '}', authority_name.to_s)
|
1469
|
-
|
1470
|
-
# query parameters
|
1471
|
-
query_params = {}
|
1472
|
-
|
1473
|
-
# header parameters
|
1474
|
-
header_params = {}
|
1475
|
-
|
1476
|
-
# HTTP header 'Accept' (if needed)
|
1477
|
-
local_header_accept = ['application/json']
|
1478
|
-
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
1479
|
-
|
1480
|
-
# HTTP header 'Content-Type'
|
1481
|
-
local_header_content_type = ['application/json']
|
1482
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
1483
|
-
|
1484
|
-
# form parameters
|
1485
|
-
form_params = {}
|
1486
|
-
|
1487
|
-
# http body (model)
|
1488
|
-
post_body = nil
|
1489
|
-
|
1490
|
-
auth_names = ['PureCloud OAuth']
|
1491
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1492
|
-
:header_params => header_params,
|
1493
|
-
:query_params => query_params,
|
1494
|
-
:form_params => form_params,
|
1495
|
-
:body => post_body,
|
1496
|
-
:auth_names => auth_names,
|
1497
|
-
:return_type => 'UserExternalIdentifier')
|
1498
|
-
if @api_client.config.debugging
|
1499
|
-
@api_client.config.logger.debug "API called: UsersApi#get_user_externalid_authority_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1500
|
-
end
|
1501
|
-
return data, status_code, headers
|
1502
|
-
end
|
1503
|
-
|
1504
1280
|
# Get favorites
|
1505
1281
|
#
|
1506
1282
|
# @param user_id User ID
|
@@ -2652,90 +2428,6 @@ module PureCloud
|
|
2652
2428
|
return data, status_code, headers
|
2653
2429
|
end
|
2654
2430
|
|
2655
|
-
# Get the user associated with external identifier.
|
2656
|
-
# Authority name and external key are case sensitive.
|
2657
|
-
# @param authority_name Authority Name
|
2658
|
-
# @param external_key External Key
|
2659
|
-
# @param [Hash] opts the optional parameters
|
2660
|
-
# @option opts [Array<String>] :expand Which fields, if any, to expand
|
2661
|
-
# @return [User]
|
2662
|
-
def get_users_externalid_authority_name_external_key(authority_name, external_key, opts = {})
|
2663
|
-
data, _status_code, _headers = get_users_externalid_authority_name_external_key_with_http_info(authority_name, external_key, opts)
|
2664
|
-
return data
|
2665
|
-
end
|
2666
|
-
|
2667
|
-
# Get the user associated with external identifier.
|
2668
|
-
# Authority name and external key are case sensitive.
|
2669
|
-
# @param authority_name Authority Name
|
2670
|
-
# @param external_key External Key
|
2671
|
-
# @param [Hash] opts the optional parameters
|
2672
|
-
# @option opts [Array<String>] :expand Which fields, if any, to expand
|
2673
|
-
# @return [Array<(User, Fixnum, Hash)>] User data, response status code and response headers
|
2674
|
-
def get_users_externalid_authority_name_external_key_with_http_info(authority_name, external_key, opts = {})
|
2675
|
-
if @api_client.config.debugging
|
2676
|
-
@api_client.config.logger.debug "Calling API: UsersApi.get_users_externalid_authority_name_external_key ..."
|
2677
|
-
end
|
2678
|
-
|
2679
|
-
|
2680
|
-
# verify the required parameter 'authority_name' is set
|
2681
|
-
fail ArgumentError, "Missing the required parameter 'authority_name' when calling UsersApi.get_users_externalid_authority_name_external_key" if authority_name.nil?
|
2682
|
-
|
2683
|
-
|
2684
|
-
|
2685
|
-
|
2686
|
-
|
2687
|
-
|
2688
|
-
# verify the required parameter 'external_key' is set
|
2689
|
-
fail ArgumentError, "Missing the required parameter 'external_key' when calling UsersApi.get_users_externalid_authority_name_external_key" if external_key.nil?
|
2690
|
-
|
2691
|
-
|
2692
|
-
|
2693
|
-
|
2694
|
-
|
2695
|
-
|
2696
|
-
|
2697
|
-
|
2698
|
-
|
2699
|
-
|
2700
|
-
|
2701
|
-
# resource path
|
2702
|
-
local_var_path = "/api/v2/users/externalid/{authorityName}/{externalKey}".sub('{format}','json').sub('{' + 'authorityName' + '}', authority_name.to_s).sub('{' + 'externalKey' + '}', external_key.to_s)
|
2703
|
-
|
2704
|
-
# query parameters
|
2705
|
-
query_params = {}
|
2706
|
-
query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
|
2707
|
-
|
2708
|
-
# header parameters
|
2709
|
-
header_params = {}
|
2710
|
-
|
2711
|
-
# HTTP header 'Accept' (if needed)
|
2712
|
-
local_header_accept = ['application/json']
|
2713
|
-
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
2714
|
-
|
2715
|
-
# HTTP header 'Content-Type'
|
2716
|
-
local_header_content_type = ['application/json']
|
2717
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
2718
|
-
|
2719
|
-
# form parameters
|
2720
|
-
form_params = {}
|
2721
|
-
|
2722
|
-
# http body (model)
|
2723
|
-
post_body = nil
|
2724
|
-
|
2725
|
-
auth_names = ['PureCloud OAuth']
|
2726
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
2727
|
-
:header_params => header_params,
|
2728
|
-
:query_params => query_params,
|
2729
|
-
:form_params => form_params,
|
2730
|
-
:body => post_body,
|
2731
|
-
:auth_names => auth_names,
|
2732
|
-
:return_type => 'User')
|
2733
|
-
if @api_client.config.debugging
|
2734
|
-
@api_client.config.logger.debug "API called: UsersApi#get_users_externalid_authority_name_external_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2735
|
-
end
|
2736
|
-
return data, status_code, headers
|
2737
|
-
end
|
2738
|
-
|
2739
2431
|
# Get current user details.
|
2740
2432
|
# This request is not valid when using the Client Credentials OAuth grant.
|
2741
2433
|
# @param [Hash] opts the optional parameters
|
@@ -4024,81 +3716,6 @@ module PureCloud
|
|
4024
3716
|
return data, status_code, headers
|
4025
3717
|
end
|
4026
3718
|
|
4027
|
-
# Create mapping between external identifier and user. Limit 100 per entity.
|
4028
|
-
# Authority Name and External key are case sensitive.
|
4029
|
-
# @param user_id User ID
|
4030
|
-
# @param body
|
4031
|
-
# @param [Hash] opts the optional parameters
|
4032
|
-
# @return [Array<UserExternalIdentifier>]
|
4033
|
-
def post_user_externalid(user_id, body, opts = {})
|
4034
|
-
data, _status_code, _headers = post_user_externalid_with_http_info(user_id, body, opts)
|
4035
|
-
return data
|
4036
|
-
end
|
4037
|
-
|
4038
|
-
# Create mapping between external identifier and user. Limit 100 per entity.
|
4039
|
-
# Authority Name and External key are case sensitive.
|
4040
|
-
# @param user_id User ID
|
4041
|
-
# @param body
|
4042
|
-
# @param [Hash] opts the optional parameters
|
4043
|
-
# @return [Array<(Array<UserExternalIdentifier>, Fixnum, Hash)>] Array<UserExternalIdentifier> data, response status code and response headers
|
4044
|
-
def post_user_externalid_with_http_info(user_id, body, opts = {})
|
4045
|
-
if @api_client.config.debugging
|
4046
|
-
@api_client.config.logger.debug "Calling API: UsersApi.post_user_externalid ..."
|
4047
|
-
end
|
4048
|
-
|
4049
|
-
|
4050
|
-
# verify the required parameter 'user_id' is set
|
4051
|
-
fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.post_user_externalid" if user_id.nil?
|
4052
|
-
|
4053
|
-
|
4054
|
-
|
4055
|
-
|
4056
|
-
|
4057
|
-
|
4058
|
-
# verify the required parameter 'body' is set
|
4059
|
-
fail ArgumentError, "Missing the required parameter 'body' when calling UsersApi.post_user_externalid" if body.nil?
|
4060
|
-
|
4061
|
-
|
4062
|
-
|
4063
|
-
|
4064
|
-
|
4065
|
-
# resource path
|
4066
|
-
local_var_path = "/api/v2/users/{userId}/externalid".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
|
4067
|
-
|
4068
|
-
# query parameters
|
4069
|
-
query_params = {}
|
4070
|
-
|
4071
|
-
# header parameters
|
4072
|
-
header_params = {}
|
4073
|
-
|
4074
|
-
# HTTP header 'Accept' (if needed)
|
4075
|
-
local_header_accept = ['application/json']
|
4076
|
-
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
4077
|
-
|
4078
|
-
# HTTP header 'Content-Type'
|
4079
|
-
local_header_content_type = ['application/json']
|
4080
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
4081
|
-
|
4082
|
-
# form parameters
|
4083
|
-
form_params = {}
|
4084
|
-
|
4085
|
-
# http body (model)
|
4086
|
-
post_body = @api_client.object_to_http_body(body)
|
4087
|
-
|
4088
|
-
auth_names = ['PureCloud OAuth']
|
4089
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
4090
|
-
:header_params => header_params,
|
4091
|
-
:query_params => query_params,
|
4092
|
-
:form_params => form_params,
|
4093
|
-
:body => post_body,
|
4094
|
-
:auth_names => auth_names,
|
4095
|
-
:return_type => 'Array<UserExternalIdentifier>')
|
4096
|
-
if @api_client.config.debugging
|
4097
|
-
@api_client.config.logger.debug "API called: UsersApi#post_user_externalid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
4098
|
-
end
|
4099
|
-
return data, status_code, headers
|
4100
|
-
end
|
4101
|
-
|
4102
3719
|
# Send an activation email to the user
|
4103
3720
|
#
|
4104
3721
|
# @param user_id User ID
|