purecloud 0.67.1 → 0.68.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +3 -3
- data/bin/notificationMappings.json +4 -4
- data/config-ruby.json +1 -1
- data/doc_out/ActivityCode.html.md +20 -0
- data/doc_out/ActivityCodeContainer.html.md +13 -0
- data/doc_out/AgentActivityEntityListing.html.md +2 -2
- data/doc_out/AlertingApi.html.md +137 -35
- data/doc_out/AnalyticsApi.html.md +89 -23
- data/doc_out/AttemptLimitsEntityListing.html.md +2 -2
- data/doc_out/AttemptLimitsNotification.html.md +2 -1
- data/doc_out/AttributeEntityListing.html.md +2 -2
- data/doc_out/AttributesApi.html.md +25 -7
- data/doc_out/AuthorizationApi.html.md +69 -18
- data/doc_out/CalibrationEntityListing.html.md +2 -2
- data/doc_out/CallConversationEntityListing.html.md +2 -2
- data/doc_out/CallConversationNotificationCallMediaParticipant.html.md +1 -1
- data/doc_out/CallConversationNotificationParticipants.html.md +1 -1
- data/doc_out/CallableTimeSetEntityListing.html.md +2 -2
- data/doc_out/CallableTimeSetNotification.html.md +1 -1
- data/doc_out/CallbackConversationEntityListing.html.md +2 -2
- data/doc_out/CallbackConversationNotificationCallbackMediaParticipant.html.md +1 -1
- data/doc_out/CallbackConversationNotificationParticipants.html.md +1 -1
- data/doc_out/CampaignEntityListing.html.md +2 -2
- data/doc_out/CampaignNotification.html.md +2 -2
- data/doc_out/{CampaignNotificationError.html.md → CampaignNotificationRestErrorDetail.html.md} +2 -2
- data/doc_out/CampaignProgressNotification.html.md +1 -1
- data/doc_out/CampaignRuleEntityListing.html.md +2 -2
- data/doc_out/CampaignRuleNotification.html.md +1 -1
- data/doc_out/CampaignRuleNotificationCampaignRuleActionEntities.html.md +2 -2
- data/doc_out/CampaignRuleNotificationCampaignRuleEntities.html.md +2 -3
- data/doc_out/CampaignRuleNotificationUriReference.html.md +14 -0
- data/doc_out/CampaignScheduleNotification.html.md +2 -2
- data/doc_out/CampaignSequenceEntityListing.html.md +2 -2
- data/doc_out/CampaignSequenceNotification.html.md +2 -2
- data/doc_out/CertificateAuthorityEntityListing.html.md +2 -2
- data/doc_out/ChannelEntityListing.html.md +2 -2
- data/doc_out/ChatConversationEntityListing.html.md +2 -2
- data/doc_out/ChatConversationNotificationChatMediaParticipant.html.md +1 -1
- data/doc_out/ChatConversationNotificationParticipants.html.md +1 -1
- data/doc_out/CobrowseConversationEntityListing.html.md +2 -2
- data/doc_out/CobrowseConversationNotificationCobrowseMediaParticipant.html.md +1 -1
- data/doc_out/CobrowseConversationNotificationParticipants.html.md +1 -1
- data/doc_out/CommandStatusEntityListing.html.md +2 -2
- data/doc_out/ContactListEntityListing.html.md +2 -2
- data/doc_out/ContactListNotification.html.md +2 -2
- data/doc_out/{ContactListNotificationPhoneColumn_.html.md → ContactListNotificationContactPhoneNumberColumn.html.md} +2 -2
- data/doc_out/ContentManagementApi.html.md +153 -39
- data/doc_out/ConversationEntityListing.html.md +2 -2
- data/doc_out/ConversationsApi.html.md +421 -76
- data/doc_out/CreateEmailRequest.html.md +23 -0
- data/doc_out/CreateWebChatRequest.html.md +19 -0
- data/doc_out/DIDEntityListing.html.md +2 -2
- data/doc_out/DIDPoolEntityListing.html.md +2 -2
- data/doc_out/DecisionsFileMetadataEntityListing.html.md +2 -2
- data/doc_out/DncListEntityListing.html.md +2 -2
- data/doc_out/DncListNotification.html.md +1 -1
- data/doc_out/DocumentAuditEntityListing.html.md +2 -2
- data/doc_out/DocumentDataV2Notification.html.md +26 -0
- data/doc_out/{RecordingDataNotificationUserData.html.md → DocumentDataV2NotificationCreatedBy.html.md} +2 -2
- data/doc_out/DocumentDataV2NotificationLockData.html.md +15 -0
- data/doc_out/DocumentDataV2NotificationLockInfo.html.md +15 -0
- data/doc_out/{DocumentDataNotificationUserData.html.md → DocumentDataV2NotificationUserData.html.md} +2 -2
- data/doc_out/{DocumentDataNotificationWorkspace.html.md → DocumentDataV2NotificationWorkspace.html.md} +2 -2
- data/doc_out/{DocumentDataNotificationWorkspaceData.html.md → DocumentDataV2NotificationWorkspaceData.html.md} +2 -2
- data/doc_out/DocumentEntityListing.html.md +2 -2
- data/doc_out/DomainEdgeSoftwareVersionDtoEntityListing.html.md +2 -2
- data/doc_out/DomainEntityListing.html.md +2 -2
- data/doc_out/DomainEntityListingEvaluationForm.html.md +2 -2
- data/doc_out/DomainEntityListingQueryResult.html.md +2 -2
- data/doc_out/DomainOrganizationRole.html.md +1 -1
- data/doc_out/DomainOrganizationRoleCreate.html.md +1 -1
- data/doc_out/DomainOrganizationRoleUpdate.html.md +1 -1
- data/doc_out/EdgeEntityListing.html.md +2 -2
- data/doc_out/EdgeGroupEntityListing.html.md +2 -2
- data/doc_out/EdgeLineEntityListing.html.md +2 -2
- data/doc_out/EdgeRebootParameters.html.md +13 -0
- data/doc_out/EmailConversationEntityListing.html.md +2 -2
- data/doc_out/EmailConversationNotificationEmailMediaParticipant.html.md +1 -1
- data/doc_out/EmailConversationNotificationParticipants.html.md +1 -1
- data/doc_out/EmailMessageListing.html.md +2 -2
- data/doc_out/EncryptionKeyEntityListing.html.md +2 -2
- data/doc_out/EndpointEntityListing.html.md +2 -2
- data/doc_out/Entry.html.md +2 -2
- data/doc_out/EntryFeatureBoolean.html.md +14 -0
- data/doc_out/EvaluationEntityListing.html.md +2 -2
- data/doc_out/EvaluationFormEntityListing.html.md +2 -2
- data/doc_out/EvaluatorActivityEntityListing.html.md +2 -2
- data/doc_out/ExtensionEntityListing.html.md +2 -2
- data/doc_out/ExtensionPoolEntityListing.html.md +2 -2
- data/doc_out/FaxApi.html.md +25 -7
- data/doc_out/FaxDataV2Notification.html.md +29 -0
- data/doc_out/FaxDataV2NotificationLockData.html.md +15 -0
- data/doc_out/FaxDataV2NotificationLockInfo.html.md +15 -0
- data/doc_out/{FaxDataNotificationUserData.html.md → FaxDataV2NotificationUserData.html.md} +2 -2
- data/doc_out/{FaxDataNotificationWorkspaceData.html.md → FaxDataV2NotificationWorkspaceData.html.md} +2 -2
- data/doc_out/FaxDocumentEntityListing.html.md +2 -2
- data/doc_out/GeolocationApi.html.md +17 -5
- data/doc_out/GreetingListing.html.md +2 -2
- data/doc_out/GreetingsApi.html.md +65 -17
- data/doc_out/GroupEntityListing.html.md +2 -2
- data/doc_out/GroupsApi.html.md +45 -12
- data/doc_out/HeartBeatAlertContainer.html.md +2 -2
- data/doc_out/HeartBeatRuleContainer.html.md +2 -2
- data/doc_out/IdentityProviderApi.html.md +89 -23
- data/doc_out/InboundDomainEntityListing.html.md +2 -2
- data/doc_out/InboundRouteEntityListing.html.md +2 -2
- data/doc_out/InteractionStatsAlertContainer.html.md +2 -2
- data/doc_out/InteractionStatsRuleContainer.html.md +2 -2
- data/doc_out/JsonNode.html.md +2 -2
- data/doc_out/KeywordSetEntityListing.html.md +2 -2
- data/doc_out/LanguageEntityListing.html.md +2 -2
- data/doc_out/LanguagesApi.html.md +41 -11
- data/doc_out/LibraryEntityListing.html.md +2 -2
- data/doc_out/LineBaseEntityListing.html.md +2 -2
- data/doc_out/LineEntityListing.html.md +2 -2
- data/doc_out/LocalEncryptionConfigurationListing.html.md +2 -2
- data/doc_out/LocationsApi.html.md +17 -5
- data/doc_out/LogicalInterfaceEntityListing.html.md +2 -2
- data/doc_out/NotificationsApi.html.md +29 -8
- data/doc_out/OAuthApi.html.md +25 -7
- data/doc_out/OAuthClientEntityListing.html.md +2 -2
- data/doc_out/OAuthProviderEntityListing.html.md +2 -2
- data/doc_out/Organization.html.md +1 -0
- data/doc_out/OrganizationApi.html.md +70 -3
- data/doc_out/OrganizationPresenceEntityListing.html.md +2 -2
- data/doc_out/OrganizationRoleEntityListing.html.md +2 -2
- data/doc_out/OrphanRecordingListing.html.md +2 -2
- data/doc_out/OutOfOfficeNotification.html.md +1 -1
- data/doc_out/OutboundApi.html.md +323 -95
- data/doc_out/OutboundRouteBaseEntityListing.html.md +2 -2
- data/doc_out/OutboundRouteEntityListing.html.md +2 -2
- data/doc_out/PermissionCollectionEntityListing.html.md +2 -2
- data/doc_out/PhoneBaseEntityListing.html.md +2 -2
- data/doc_out/PhoneEntityListing.html.md +2 -2
- data/doc_out/PhoneMetaBaseEntityListing.html.md +2 -2
- data/doc_out/PhysicalInterfaceEntityListing.html.md +2 -2
- data/doc_out/PolicyEntityListing.html.md +2 -2
- data/doc_out/PresenceApi.html.md +33 -9
- data/doc_out/QualityApi.html.md +128 -33
- data/doc_out/QualityAuditPage.html.md +2 -2
- data/doc_out/QueueEntityListing.html.md +2 -2
- data/doc_out/QueueMemberEntityListing.html.md +2 -2
- data/doc_out/RecordingApi.html.md +133 -34
- data/doc_out/RecordingDataV2Notification.html.md +29 -0
- data/doc_out/{RecordingDataNotificationConversationData.html.md → RecordingDataV2NotificationConversationData.html.md} +2 -2
- data/doc_out/RecordingDataV2NotificationLockData.html.md +15 -0
- data/doc_out/RecordingDataV2NotificationLockInfo.html.md +15 -0
- data/doc_out/{DocumentDataNotificationCreatedBy.html.md → RecordingDataV2NotificationUserData.html.md} +2 -2
- data/doc_out/{RecordingDataNotificationWorkspaceData.html.md → RecordingDataV2NotificationWorkspaceData.html.md} +2 -2
- data/doc_out/ReportMetaDataEntityListing.html.md +2 -2
- data/doc_out/ReportRunEntryEntityDomainListing.html.md +2 -2
- data/doc_out/ReportScheduleEntityListing.html.md +2 -2
- data/doc_out/ResponseEntityList.html.md +2 -2
- data/doc_out/ResponseEntityListing.html.md +2 -2
- data/doc_out/ResponseManagementApi.html.md +45 -12
- data/doc_out/ResponseSetEntityListing.html.md +2 -2
- data/doc_out/ResponseSetNotification.html.md +1 -1
- data/doc_out/RoutingApi.html.md +193 -49
- data/doc_out/RoutingStatusAlertContainer.html.md +2 -2
- data/doc_out/RoutingStatusRuleContainer.html.md +2 -2
- data/doc_out/RuleSetEntityListing.html.md +2 -2
- data/doc_out/RuleSetNotification.html.md +1 -1
- data/doc_out/RuleSetNotificationCondition.html.md +1 -1
- data/doc_out/RuleSetNotificationConditions.html.md +1 -1
- data/doc_out/SchemaCategoryEntityListing.html.md +2 -2
- data/doc_out/SchemaReferenceEntityListing.html.md +2 -2
- data/doc_out/ScreenRecordingSessionListing.html.md +2 -2
- data/doc_out/ScreenShareConversationNotificationParticipants.html.md +1 -1
- data/doc_out/ScreenShareConversationNotificationScreenShareMediaParticipant.html.md +1 -1
- data/doc_out/ScriptEntityListing.html.md +2 -2
- data/doc_out/ScriptsApi.html.md +37 -10
- data/doc_out/SearchApi.html.md +49 -13
- data/doc_out/SecurityProfileEntityListing.html.md +2 -2
- data/doc_out/SequenceScheduleNotification.html.md +2 -2
- data/doc_out/ShareEntityListing.html.md +2 -2
- data/doc_out/SiteEntityListing.html.md +2 -2
- data/doc_out/SkillEntityListing.html.md +2 -2
- data/doc_out/SocialConversationNotificationParticipants.html.md +1 -1
- data/doc_out/SocialConversationNotificationSocialMediaParticipant.html.md +1 -1
- data/doc_out/StationEntityListing.html.md +2 -2
- data/doc_out/StationsApi.html.md +13 -4
- data/doc_out/SuggestApi.html.md +17 -5
- data/doc_out/TagValueEntityListing.html.md +2 -2
- data/doc_out/TelephonyProvidersEdgeApi.html.md +479 -121
- data/doc_out/TimeZoneEntityListing.html.md +2 -2
- data/doc_out/TokensApi.html.md +5 -2
- data/doc_out/TrunkBaseEntityListing.html.md +2 -2
- data/doc_out/TrunkEntityListing.html.md +2 -2
- data/doc_out/TrunkMetabaseEntityListing.html.md +2 -2
- data/doc_out/UserEntityListing.html.md +2 -2
- data/doc_out/UserListScheduleRequestBody.html.md +15 -0
- data/doc_out/UserPresenceAlertContainer.html.md +2 -2
- data/doc_out/UserPresenceRuleContainer.html.md +2 -2
- data/doc_out/UserQueueEntityListing.html.md +2 -2
- data/doc_out/UserRecordingEntityListing.html.md +2 -2
- data/doc_out/UserRecordingsApi.html.md +25 -7
- data/doc_out/UserSchedule.html.md +14 -0
- data/doc_out/UserScheduleActivity.html.md +18 -0
- data/doc_out/UserScheduleContainer.html.md +14 -0
- data/doc_out/UserScheduleFullDayTimeOffMarker.html.md +17 -0
- data/doc_out/UserScheduleShift.html.md +15 -0
- data/doc_out/UserSkillEntityListing.html.md +2 -2
- data/doc_out/UsersApi.html.md +169 -43
- data/doc_out/UtilitiesApi.html.md +13 -4
- data/doc_out/VideoConversationNotificationParticipants.html.md +1 -1
- data/doc_out/VideoConversationNotificationVideoMediaParticipant.html.md +1 -1
- data/doc_out/VoicemailApi.html.md +89 -23
- data/doc_out/VoicemailMessageEntityListing.html.md +2 -2
- data/doc_out/WfmUserEntityListing.html.md +13 -0
- data/doc_out/WorkforceManagementApi.html.md +227 -13
- data/doc_out/WorkspaceEntityListing.html.md +2 -2
- data/doc_out/WorkspaceMemberEntityListing.html.md +2 -2
- data/doc_out/WrapUpCodeMappingNotification.html.md +0 -1
- data/doc_out/WrapupCodeEntityListing.html.md +2 -2
- data/doc_out/index.html.md +3 -3
- data/lib/purecloud.rb +34 -20
- data/lib/purecloud/api/conversations_api.rb +120 -0
- data/lib/purecloud/api/organization_api.rb +57 -0
- data/lib/purecloud/api/outbound_api.rb +9 -9
- data/lib/purecloud/api/quality_api.rb +7 -0
- data/lib/purecloud/api/telephony_providers_edge_api.rb +3 -1
- data/lib/purecloud/api/workforce_management_api.rb +185 -3
- data/lib/purecloud/api_client.rb +1 -1
- data/lib/purecloud/models/activity_code.rb +253 -0
- data/lib/purecloud/models/activity_code_container.rb +169 -0
- data/lib/purecloud/models/agent_activity_entity_listing.rb +17 -17
- data/lib/purecloud/models/attempt_limits_entity_listing.rb +17 -17
- data/lib/purecloud/models/attempt_limits_notification.rb +24 -14
- data/lib/purecloud/models/attribute_entity_listing.rb +17 -17
- data/lib/purecloud/models/calibration_entity_listing.rb +17 -17
- data/lib/purecloud/models/call_conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/call_conversation_notification_call_media_participant.rb +1 -1
- data/lib/purecloud/models/call_conversation_notification_participants.rb +1 -1
- data/lib/purecloud/models/callable_time_set_entity_listing.rb +17 -17
- data/lib/purecloud/models/callable_time_set_notification.rb +13 -13
- data/lib/purecloud/models/callback_conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/callback_conversation_notification_callback_media_participant.rb +1 -1
- data/lib/purecloud/models/callback_conversation_notification_participants.rb +1 -1
- data/lib/purecloud/models/campaign_entity_listing.rb +17 -17
- data/lib/purecloud/models/campaign_notification.rb +15 -15
- data/lib/purecloud/models/{campaign_notification_error.rb → campaign_notification_rest_error_detail.rb} +1 -1
- data/lib/purecloud/models/campaign_progress_notification.rb +1 -1
- data/lib/purecloud/models/campaign_rule_entity_listing.rb +17 -17
- data/lib/purecloud/models/campaign_rule_notification.rb +14 -14
- data/lib/purecloud/models/campaign_rule_notification_campaign_rule_action_entities.rb +2 -2
- data/lib/purecloud/models/campaign_rule_notification_campaign_rule_entities.rb +3 -13
- data/lib/purecloud/models/campaign_rule_notification_uri_reference.rb +175 -0
- data/lib/purecloud/models/campaign_schedule_notification.rb +14 -14
- data/lib/purecloud/models/campaign_sequence_entity_listing.rb +17 -17
- data/lib/purecloud/models/campaign_sequence_notification.rb +15 -15
- data/lib/purecloud/models/certificate_authority_entity_listing.rb +17 -17
- data/lib/purecloud/models/channel_entity_listing.rb +17 -17
- data/lib/purecloud/models/chat_conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/chat_conversation_notification_chat_media_participant.rb +1 -1
- data/lib/purecloud/models/chat_conversation_notification_participants.rb +1 -1
- data/lib/purecloud/models/cobrowse_conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/cobrowse_conversation_notification_cobrowse_media_participant.rb +1 -1
- data/lib/purecloud/models/cobrowse_conversation_notification_participants.rb +1 -1
- data/lib/purecloud/models/command_status_entity_listing.rb +17 -17
- data/lib/purecloud/models/contact_list_entity_listing.rb +17 -17
- data/lib/purecloud/models/contact_list_notification.rb +14 -14
- data/lib/purecloud/models/{contact_list_notification_phone_column_.rb → contact_list_notification_contact_phone_number_column.rb} +1 -1
- data/lib/purecloud/models/contact_list_notification_import_status.rb +1 -1
- data/lib/purecloud/models/conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/create_email_request.rb +280 -0
- data/lib/purecloud/models/create_web_chat_request.rb +236 -0
- data/lib/purecloud/models/decisions_file_metadata_entity_listing.rb +17 -17
- data/lib/purecloud/models/did_entity_listing.rb +17 -17
- data/lib/purecloud/models/did_pool_entity_listing.rb +17 -17
- data/lib/purecloud/models/dnc_list_entity_listing.rb +17 -17
- data/lib/purecloud/models/dnc_list_notification.rb +14 -14
- data/lib/purecloud/models/dnc_list_notification_import_status.rb +1 -1
- data/lib/purecloud/models/document_audit_entity_listing.rb +17 -17
- data/lib/purecloud/models/{document_data_notification.rb → document_data_v2_notification.rb} +9 -29
- data/lib/purecloud/models/{recording_data_notification_user_data.rb → document_data_v2_notification_created_by.rb} +1 -1
- data/lib/purecloud/models/{document_data_notification_lock_info.rb → document_data_v2_notification_lock_data.rb} +4 -4
- data/lib/purecloud/models/{document_data_notification_lock_data.rb → document_data_v2_notification_lock_info.rb} +4 -4
- data/lib/purecloud/models/{document_data_notification_user_data.rb → document_data_v2_notification_user_data.rb} +1 -1
- data/lib/purecloud/models/{document_data_notification_workspace.rb → document_data_v2_notification_workspace.rb} +1 -1
- data/lib/purecloud/models/{document_data_notification_workspace_data.rb → document_data_v2_notification_workspace_data.rb} +1 -1
- data/lib/purecloud/models/document_entity_listing.rb +17 -17
- data/lib/purecloud/models/domain_edge_software_version_dto_entity_listing.rb +17 -17
- data/lib/purecloud/models/domain_entity_listing.rb +17 -17
- data/lib/purecloud/models/domain_entity_listing_evaluation_form.rb +17 -17
- data/lib/purecloud/models/domain_entity_listing_query_result.rb +17 -17
- data/lib/purecloud/models/domain_organization_role.rb +11 -11
- data/lib/purecloud/models/domain_organization_role_create.rb +11 -11
- data/lib/purecloud/models/domain_organization_role_update.rb +11 -11
- data/lib/purecloud/models/edge_entity_listing.rb +17 -17
- data/lib/purecloud/models/edge_group_entity_listing.rb +17 -17
- data/lib/purecloud/models/edge_line_entity_listing.rb +17 -17
- data/lib/purecloud/models/edge_reboot_parameters.rb +166 -0
- data/lib/purecloud/models/email_conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/email_conversation_notification_email_media_participant.rb +1 -1
- data/lib/purecloud/models/email_conversation_notification_participants.rb +1 -1
- data/lib/purecloud/models/email_message_listing.rb +17 -17
- data/lib/purecloud/models/encryption_key_entity_listing.rb +17 -17
- data/lib/purecloud/models/endpoint_entity_listing.rb +17 -17
- data/lib/purecloud/models/entry.rb +8 -10
- data/lib/purecloud/models/entry_feature_boolean.rb +184 -0
- data/lib/purecloud/models/evaluation_entity_listing.rb +17 -17
- data/lib/purecloud/models/evaluation_form_entity_listing.rb +17 -17
- data/lib/purecloud/models/evaluator_activity_entity_listing.rb +17 -17
- data/lib/purecloud/models/extension_entity_listing.rb +17 -17
- data/lib/purecloud/models/extension_pool_entity_listing.rb +17 -17
- data/lib/purecloud/models/{fax_data_notification.rb → fax_data_v2_notification.rb} +9 -29
- data/lib/purecloud/models/{fax_data_notification_lock_info.rb → fax_data_v2_notification_lock_data.rb} +4 -4
- data/lib/purecloud/models/{fax_data_notification_lock_data.rb → fax_data_v2_notification_lock_info.rb} +4 -4
- data/lib/purecloud/models/{fax_data_notification_user_data.rb → fax_data_v2_notification_user_data.rb} +1 -1
- data/lib/purecloud/models/{fax_data_notification_workspace_data.rb → fax_data_v2_notification_workspace_data.rb} +1 -1
- data/lib/purecloud/models/fax_document_entity_listing.rb +17 -17
- data/lib/purecloud/models/greeting_listing.rb +17 -17
- data/lib/purecloud/models/group_entity_listing.rb +17 -17
- data/lib/purecloud/models/heart_beat_alert_container.rb +17 -17
- data/lib/purecloud/models/heart_beat_rule_container.rb +17 -17
- data/lib/purecloud/models/import_status_notification.rb +1 -1
- data/lib/purecloud/models/inbound_domain_entity_listing.rb +17 -17
- data/lib/purecloud/models/inbound_route_entity_listing.rb +17 -17
- data/lib/purecloud/models/interaction_stats_alert_container.rb +17 -17
- data/lib/purecloud/models/interaction_stats_rule_container.rb +17 -17
- data/lib/purecloud/models/json_node.rb +24 -24
- data/lib/purecloud/models/keyword_set_entity_listing.rb +17 -17
- data/lib/purecloud/models/language_entity_listing.rb +17 -17
- data/lib/purecloud/models/library_entity_listing.rb +17 -17
- data/lib/purecloud/models/line_base_entity_listing.rb +17 -17
- data/lib/purecloud/models/line_entity_listing.rb +17 -17
- data/lib/purecloud/models/local_encryption_configuration_listing.rb +17 -17
- data/lib/purecloud/models/logical_interface_entity_listing.rb +17 -17
- data/lib/purecloud/models/o_auth_client_entity_listing.rb +17 -17
- data/lib/purecloud/models/o_auth_provider_entity_listing.rb +17 -17
- data/lib/purecloud/models/organization.rb +17 -4
- data/lib/purecloud/models/organization_presence_entity_listing.rb +17 -17
- data/lib/purecloud/models/organization_role_entity_listing.rb +17 -17
- data/lib/purecloud/models/orphan_recording_listing.rb +17 -17
- data/lib/purecloud/models/out_of_office_notification.rb +1 -1
- data/lib/purecloud/models/outbound_route_base_entity_listing.rb +17 -17
- data/lib/purecloud/models/outbound_route_entity_listing.rb +17 -17
- data/lib/purecloud/models/permission_collection_entity_listing.rb +17 -17
- data/lib/purecloud/models/phone_base_entity_listing.rb +17 -17
- data/lib/purecloud/models/phone_entity_listing.rb +17 -17
- data/lib/purecloud/models/phone_meta_base_entity_listing.rb +17 -17
- data/lib/purecloud/models/physical_interface_entity_listing.rb +17 -17
- data/lib/purecloud/models/policy_entity_listing.rb +17 -17
- data/lib/purecloud/models/quality_audit_page.rb +17 -17
- data/lib/purecloud/models/queue_entity_listing.rb +17 -17
- data/lib/purecloud/models/queue_member_entity_listing.rb +17 -17
- data/lib/purecloud/models/{recording_data_notification.rb → recording_data_v2_notification.rb} +10 -30
- data/lib/purecloud/models/{recording_data_notification_conversation_data.rb → recording_data_v2_notification_conversation_data.rb} +1 -1
- data/lib/purecloud/models/recording_data_v2_notification_lock_data.rb +185 -0
- data/lib/purecloud/models/recording_data_v2_notification_lock_info.rb +185 -0
- data/lib/purecloud/models/{document_data_notification_created_by.rb → recording_data_v2_notification_user_data.rb} +1 -1
- data/lib/purecloud/models/{recording_data_notification_workspace_data.rb → recording_data_v2_notification_workspace_data.rb} +1 -1
- data/lib/purecloud/models/report_meta_data_entity_listing.rb +17 -17
- data/lib/purecloud/models/report_run_entry_entity_domain_listing.rb +17 -17
- data/lib/purecloud/models/report_schedule_entity_listing.rb +17 -17
- data/lib/purecloud/models/response_entity_list.rb +17 -17
- data/lib/purecloud/models/response_entity_listing.rb +17 -17
- data/lib/purecloud/models/response_set_entity_listing.rb +17 -17
- data/lib/purecloud/models/response_set_notification.rb +13 -13
- data/lib/purecloud/models/routing_status_alert_container.rb +17 -17
- data/lib/purecloud/models/routing_status_rule_container.rb +17 -17
- data/lib/purecloud/models/rule_set_entity_listing.rb +17 -17
- data/lib/purecloud/models/rule_set_notification.rb +1 -1
- data/lib/purecloud/models/rule_set_notification_condition.rb +11 -11
- data/lib/purecloud/models/rule_set_notification_conditions.rb +18 -18
- data/lib/purecloud/models/rule_set_notification_rule.rb +9 -0
- data/lib/purecloud/models/rule_set_notification_rules.rb +9 -0
- data/lib/purecloud/models/schema_category_entity_listing.rb +17 -17
- data/lib/purecloud/models/schema_reference_entity_listing.rb +17 -17
- data/lib/purecloud/models/screen_recording_session_listing.rb +17 -17
- data/lib/purecloud/models/screen_share_conversation_notification_participants.rb +1 -1
- data/lib/purecloud/models/screen_share_conversation_notification_screen_share_media_participant.rb +1 -1
- data/lib/purecloud/models/script_entity_listing.rb +17 -17
- data/lib/purecloud/models/security_profile_entity_listing.rb +17 -17
- data/lib/purecloud/models/sequence_schedule_notification.rb +14 -14
- data/lib/purecloud/models/share_entity_listing.rb +17 -17
- data/lib/purecloud/models/site_entity_listing.rb +17 -17
- data/lib/purecloud/models/skill_entity_listing.rb +17 -17
- data/lib/purecloud/models/social_conversation_notification_participants.rb +1 -1
- data/lib/purecloud/models/social_conversation_notification_social_media_participant.rb +1 -1
- data/lib/purecloud/models/station_entity_listing.rb +17 -17
- data/lib/purecloud/models/tag_value_entity_listing.rb +17 -17
- data/lib/purecloud/models/time_zone_entity_listing.rb +17 -17
- data/lib/purecloud/models/trunk_base_entity_listing.rb +17 -17
- data/lib/purecloud/models/trunk_entity_listing.rb +17 -17
- data/lib/purecloud/models/trunk_metabase_entity_listing.rb +17 -17
- data/lib/purecloud/models/user_entity_listing.rb +17 -17
- data/lib/purecloud/models/user_list_schedule_request_body.rb +191 -0
- data/lib/purecloud/models/user_presence_alert_container.rb +17 -17
- data/lib/purecloud/models/user_presence_rule_container.rb +17 -17
- data/lib/purecloud/models/user_queue_entity_listing.rb +17 -17
- data/lib/purecloud/models/user_recording_entity_listing.rb +17 -17
- data/lib/purecloud/models/user_schedule.rb +182 -0
- data/lib/purecloud/models/user_schedule_activity.rb +222 -0
- data/lib/purecloud/models/user_schedule_container.rb +180 -0
- data/lib/purecloud/models/user_schedule_full_day_time_off_marker.rb +211 -0
- data/lib/purecloud/models/user_schedule_shift.rb +191 -0
- data/lib/purecloud/models/user_skill_entity_listing.rb +17 -17
- data/lib/purecloud/models/video_conversation_notification_participants.rb +1 -1
- data/lib/purecloud/models/video_conversation_notification_video_media_participant.rb +1 -1
- data/lib/purecloud/models/voicemail_message_entity_listing.rb +17 -17
- data/lib/purecloud/models/wfm_user_entity_listing.rb +167 -0
- data/lib/purecloud/models/workspace_entity_listing.rb +17 -17
- data/lib/purecloud/models/workspace_member_entity_listing.rb +17 -17
- data/lib/purecloud/models/wrap_up_code_mapping_notification.rb +4 -14
- data/lib/purecloud/models/wrapup_code_entity_listing.rb +17 -17
- data/lib/purecloud/version.rb +1 -1
- data/newVersion.md +1 -1
- data/swagger.json +1 -1
- data/swagger_template/api_doc.mustache +5 -2
- data/version.json +1 -1
- metadata +70 -42
- data/doc_out/DocumentDataNotification.html.md +0 -28
- data/doc_out/DocumentDataNotificationLockData.html.md +0 -15
- data/doc_out/DocumentDataNotificationLockInfo.html.md +0 -15
- data/doc_out/FaxDataNotification.html.md +0 -31
- data/doc_out/FaxDataNotificationLockData.html.md +0 -15
- data/doc_out/FaxDataNotificationLockInfo.html.md +0 -15
- data/doc_out/RecordingDataNotification.html.md +0 -31
- data/doc_out/RecordingDataNotificationLockData.html.md +0 -15
- data/doc_out/RecordingDataNotificationLockInfo.html.md +0 -15
- data/lib/purecloud/models/recording_data_notification_lock_data.rb +0 -185
- data/lib/purecloud/models/recording_data_notification_lock_info.rb +0 -185
|
@@ -6,30 +6,30 @@ title: AnalyticsApi
|
|
|
6
6
|
|
|
7
7
|
All URIs are relative to *https://api.mypurecloud.com*
|
|
8
8
|
|
|
9
|
-
Method |
|
|
9
|
+
Method | Description
|
|
10
10
|
------------- | ------------- | -------------
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
11
|
+
[**delete_reporting_schedules_schedule_id**](AnalyticsApi.html#delete_reporting_schedules_schedule_id) | Delete a scheduled report job.
|
|
12
|
+
[**get_conversations_conversation_id_details**](AnalyticsApi.html#get_conversations_conversation_id_details) | Get a conversation by id
|
|
13
|
+
[**get_reporting_metadata**](AnalyticsApi.html#get_reporting_metadata) | Get list of reporting metadata.
|
|
14
|
+
[**get_reporting_report_id_metadata**](AnalyticsApi.html#get_reporting_report_id_metadata) | Get a reporting metadata.
|
|
15
|
+
[**get_reporting_reportformats**](AnalyticsApi.html#get_reporting_reportformats) | Get a list of report formats
|
|
16
|
+
[**get_reporting_schedules**](AnalyticsApi.html#get_reporting_schedules) | Get a list of scheduled report jobs
|
|
17
|
+
[**get_reporting_schedules_schedule_id**](AnalyticsApi.html#get_reporting_schedules_schedule_id) | Get a scheduled report job.
|
|
18
|
+
[**get_reporting_schedules_schedule_id_history**](AnalyticsApi.html#get_reporting_schedules_schedule_id_history) | Get list of completed scheduled report jobs.
|
|
19
|
+
[**get_reporting_schedules_schedule_id_history_latest**](AnalyticsApi.html#get_reporting_schedules_schedule_id_history_latest) | Get most recently completed scheduled report job.
|
|
20
|
+
[**get_reporting_schedules_schedule_id_history_run_id**](AnalyticsApi.html#get_reporting_schedules_schedule_id_history_run_id) | A completed scheduled report job
|
|
21
|
+
[**get_reporting_timeperiods**](AnalyticsApi.html#get_reporting_timeperiods) | Get a list of report time periods.
|
|
22
|
+
[**post_conversations_aggregates_query**](AnalyticsApi.html#post_conversations_aggregates_query) | Query for conversation aggregates
|
|
23
|
+
[**post_conversations_conversation_id_details_properties**](AnalyticsApi.html#post_conversations_conversation_id_details_properties) | Index conversation properties
|
|
24
|
+
[**post_conversations_details_query**](AnalyticsApi.html#post_conversations_details_query) | Query for conversation details
|
|
25
|
+
[**post_evaluations_aggregates_query**](AnalyticsApi.html#post_evaluations_aggregates_query) | Query for evaluation aggregates
|
|
26
|
+
[**post_queues_observations_query**](AnalyticsApi.html#post_queues_observations_query) | Query for queue observations
|
|
27
|
+
[**post_reporting_schedules**](AnalyticsApi.html#post_reporting_schedules) | Create a scheduled report job
|
|
28
|
+
[**post_reporting_schedules_schedule_id_runreport**](AnalyticsApi.html#post_reporting_schedules_schedule_id_runreport) | Place a scheduled report immediately into the reporting queue
|
|
29
|
+
[**post_users_aggregates_query**](AnalyticsApi.html#post_users_aggregates_query) | Query for user aggregates
|
|
30
|
+
[**post_users_details_query**](AnalyticsApi.html#post_users_details_query) | Query for user details
|
|
31
|
+
[**post_users_observations_query**](AnalyticsApi.html#post_users_observations_query) | Query for user observations
|
|
32
|
+
[**put_reporting_schedules_schedule_id**](AnalyticsApi.html#put_reporting_schedules_schedule_id) | Update a scheduled report job.
|
|
33
33
|
{: class="table table-striped"}
|
|
34
34
|
|
|
35
35
|
<a name="delete_reporting_schedules_schedule_id"></a>
|
|
@@ -40,6 +40,9 @@ Delete a scheduled report job.
|
|
|
40
40
|
|
|
41
41
|
|
|
42
42
|
|
|
43
|
+
Wraps DELETE /api/v2/analytics/reporting/schedules/{scheduleId}
|
|
44
|
+
|
|
45
|
+
|
|
43
46
|
### Example
|
|
44
47
|
~~~ruby
|
|
45
48
|
# load the gem
|
|
@@ -96,6 +99,9 @@ Get a conversation by id
|
|
|
96
99
|
|
|
97
100
|
|
|
98
101
|
|
|
102
|
+
Wraps GET /api/v2/analytics/conversations/{conversationId}/details
|
|
103
|
+
|
|
104
|
+
|
|
99
105
|
### Example
|
|
100
106
|
~~~ruby
|
|
101
107
|
# load the gem
|
|
@@ -152,6 +158,9 @@ Get list of reporting metadata.
|
|
|
152
158
|
|
|
153
159
|
|
|
154
160
|
|
|
161
|
+
Wraps GET /api/v2/analytics/reporting/metadata
|
|
162
|
+
|
|
163
|
+
|
|
155
164
|
### Example
|
|
156
165
|
~~~ruby
|
|
157
166
|
# load the gem
|
|
@@ -213,6 +222,9 @@ Get a reporting metadata.
|
|
|
213
222
|
|
|
214
223
|
|
|
215
224
|
|
|
225
|
+
Wraps GET /api/v2/analytics/reporting/{reportId}/metadata
|
|
226
|
+
|
|
227
|
+
|
|
216
228
|
### Example
|
|
217
229
|
~~~ruby
|
|
218
230
|
# load the gem
|
|
@@ -273,6 +285,9 @@ Get a list of report formats
|
|
|
273
285
|
|
|
274
286
|
Get a list of report formats.
|
|
275
287
|
|
|
288
|
+
Wraps GET /api/v2/analytics/reporting/reportformats
|
|
289
|
+
|
|
290
|
+
|
|
276
291
|
### Example
|
|
277
292
|
~~~ruby
|
|
278
293
|
# load the gem
|
|
@@ -323,6 +338,9 @@ Get a list of scheduled report jobs
|
|
|
323
338
|
|
|
324
339
|
Get a list of scheduled report jobs.
|
|
325
340
|
|
|
341
|
+
Wraps GET /api/v2/analytics/reporting/schedules
|
|
342
|
+
|
|
343
|
+
|
|
326
344
|
### Example
|
|
327
345
|
~~~ruby
|
|
328
346
|
# load the gem
|
|
@@ -382,6 +400,9 @@ Get a scheduled report job.
|
|
|
382
400
|
|
|
383
401
|
|
|
384
402
|
|
|
403
|
+
Wraps GET /api/v2/analytics/reporting/schedules/{scheduleId}
|
|
404
|
+
|
|
405
|
+
|
|
385
406
|
### Example
|
|
386
407
|
~~~ruby
|
|
387
408
|
# load the gem
|
|
@@ -438,6 +459,9 @@ Get list of completed scheduled report jobs.
|
|
|
438
459
|
|
|
439
460
|
|
|
440
461
|
|
|
462
|
+
Wraps GET /api/v2/analytics/reporting/schedules/{scheduleId}/history
|
|
463
|
+
|
|
464
|
+
|
|
441
465
|
### Example
|
|
442
466
|
~~~ruby
|
|
443
467
|
# load the gem
|
|
@@ -500,6 +524,9 @@ Get most recently completed scheduled report job.
|
|
|
500
524
|
|
|
501
525
|
|
|
502
526
|
|
|
527
|
+
Wraps GET /api/v2/analytics/reporting/schedules/{scheduleId}/history/latest
|
|
528
|
+
|
|
529
|
+
|
|
503
530
|
### Example
|
|
504
531
|
~~~ruby
|
|
505
532
|
# load the gem
|
|
@@ -556,6 +583,9 @@ A completed scheduled report job
|
|
|
556
583
|
|
|
557
584
|
A completed scheduled report job.
|
|
558
585
|
|
|
586
|
+
Wraps GET /api/v2/analytics/reporting/schedules/{scheduleId}/history/{runId}
|
|
587
|
+
|
|
588
|
+
|
|
559
589
|
### Example
|
|
560
590
|
~~~ruby
|
|
561
591
|
# load the gem
|
|
@@ -615,6 +645,9 @@ Get a list of report time periods.
|
|
|
615
645
|
|
|
616
646
|
|
|
617
647
|
|
|
648
|
+
Wraps GET /api/v2/analytics/reporting/timeperiods
|
|
649
|
+
|
|
650
|
+
|
|
618
651
|
### Example
|
|
619
652
|
~~~ruby
|
|
620
653
|
# load the gem
|
|
@@ -665,6 +698,9 @@ Query for conversation aggregates
|
|
|
665
698
|
|
|
666
699
|
|
|
667
700
|
|
|
701
|
+
Wraps POST /api/v2/analytics/conversations/aggregates/query
|
|
702
|
+
|
|
703
|
+
|
|
668
704
|
### Example
|
|
669
705
|
~~~ruby
|
|
670
706
|
# load the gem
|
|
@@ -721,6 +757,9 @@ Index conversation properties
|
|
|
721
757
|
|
|
722
758
|
|
|
723
759
|
|
|
760
|
+
Wraps POST /api/v2/analytics/conversations/{conversationId}/details/properties
|
|
761
|
+
|
|
762
|
+
|
|
724
763
|
### Example
|
|
725
764
|
~~~ruby
|
|
726
765
|
# load the gem
|
|
@@ -780,6 +819,9 @@ Query for conversation details
|
|
|
780
819
|
|
|
781
820
|
|
|
782
821
|
|
|
822
|
+
Wraps POST /api/v2/analytics/conversations/details/query
|
|
823
|
+
|
|
824
|
+
|
|
783
825
|
### Example
|
|
784
826
|
~~~ruby
|
|
785
827
|
# load the gem
|
|
@@ -836,6 +878,9 @@ Query for evaluation aggregates
|
|
|
836
878
|
|
|
837
879
|
|
|
838
880
|
|
|
881
|
+
Wraps POST /api/v2/analytics/evaluations/aggregates/query
|
|
882
|
+
|
|
883
|
+
|
|
839
884
|
### Example
|
|
840
885
|
~~~ruby
|
|
841
886
|
# load the gem
|
|
@@ -892,6 +937,9 @@ Query for queue observations
|
|
|
892
937
|
|
|
893
938
|
|
|
894
939
|
|
|
940
|
+
Wraps POST /api/v2/analytics/queues/observations/query
|
|
941
|
+
|
|
942
|
+
|
|
895
943
|
### Example
|
|
896
944
|
~~~ruby
|
|
897
945
|
# load the gem
|
|
@@ -948,6 +996,9 @@ Create a scheduled report job
|
|
|
948
996
|
|
|
949
997
|
Create a scheduled report job.
|
|
950
998
|
|
|
999
|
+
Wraps POST /api/v2/analytics/reporting/schedules
|
|
1000
|
+
|
|
1001
|
+
|
|
951
1002
|
### Example
|
|
952
1003
|
~~~ruby
|
|
953
1004
|
# load the gem
|
|
@@ -1004,6 +1055,9 @@ Place a scheduled report immediately into the reporting queue
|
|
|
1004
1055
|
|
|
1005
1056
|
|
|
1006
1057
|
|
|
1058
|
+
Wraps POST /api/v2/analytics/reporting/schedules/{scheduleId}/runreport
|
|
1059
|
+
|
|
1060
|
+
|
|
1007
1061
|
### Example
|
|
1008
1062
|
~~~ruby
|
|
1009
1063
|
# load the gem
|
|
@@ -1060,6 +1114,9 @@ Query for user aggregates
|
|
|
1060
1114
|
|
|
1061
1115
|
|
|
1062
1116
|
|
|
1117
|
+
Wraps POST /api/v2/analytics/users/aggregates/query
|
|
1118
|
+
|
|
1119
|
+
|
|
1063
1120
|
### Example
|
|
1064
1121
|
~~~ruby
|
|
1065
1122
|
# load the gem
|
|
@@ -1116,6 +1173,9 @@ Query for user details
|
|
|
1116
1173
|
|
|
1117
1174
|
|
|
1118
1175
|
|
|
1176
|
+
Wraps POST /api/v2/analytics/users/details/query
|
|
1177
|
+
|
|
1178
|
+
|
|
1119
1179
|
### Example
|
|
1120
1180
|
~~~ruby
|
|
1121
1181
|
# load the gem
|
|
@@ -1172,6 +1232,9 @@ Query for user observations
|
|
|
1172
1232
|
|
|
1173
1233
|
|
|
1174
1234
|
|
|
1235
|
+
Wraps POST /api/v2/analytics/users/observations/query
|
|
1236
|
+
|
|
1237
|
+
|
|
1175
1238
|
### Example
|
|
1176
1239
|
~~~ruby
|
|
1177
1240
|
# load the gem
|
|
@@ -1228,6 +1291,9 @@ Update a scheduled report job.
|
|
|
1228
1291
|
|
|
1229
1292
|
|
|
1230
1293
|
|
|
1294
|
+
Wraps PUT /api/v2/analytics/reporting/schedules/{scheduleId}
|
|
1295
|
+
|
|
1296
|
+
|
|
1231
1297
|
### Example
|
|
1232
1298
|
~~~ruby
|
|
1233
1299
|
# load the gem
|
|
@@ -11,11 +11,11 @@ title: AttemptLimitsEntityListing
|
|
|
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
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -12,12 +12,13 @@ title: AttemptLimitsNotification
|
|
|
12
12
|
| **date_created** | **DateTime** | | [optional] |
|
|
13
13
|
| **date_modified** | **DateTime** | | [optional] |
|
|
14
14
|
| **version** | **Integer** | | [optional] |
|
|
15
|
-
| **additional_properties** | **Object** | | [optional] |
|
|
16
15
|
| **max_attempts_per_contact** | **Integer** | | [optional] |
|
|
17
16
|
| **max_attempts_per_number** | **Integer** | | [optional] |
|
|
18
17
|
| **time_zone_id** | **String** | | [optional] |
|
|
19
18
|
| **reset_period** | **String** | | [optional] |
|
|
20
19
|
| **recall_entries** | [**Hash<String, AttemptLimitsNotificationRecallEntries>**](AttemptLimitsNotificationRecallEntries.html) | | [optional] |
|
|
20
|
+
| **breadth_first_recalls** | **BOOLEAN** | | [optional] |
|
|
21
|
+
| **additional_properties** | **Object** | | [optional] |
|
|
21
22
|
{: class="table table-striped"}
|
|
22
23
|
|
|
23
24
|
|
|
@@ -11,11 +11,11 @@ title: AttributeEntityListing
|
|
|
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
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -6,14 +6,14 @@ title: AttributesApi
|
|
|
6
6
|
|
|
7
7
|
All URIs are relative to *https://api.mypurecloud.com*
|
|
8
8
|
|
|
9
|
-
Method |
|
|
9
|
+
Method | Description
|
|
10
10
|
------------- | ------------- | -------------
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
11
|
+
[**delete_attribute_id**](AttributesApi.html#delete_attribute_id) | Delete an existing Attribute.
|
|
12
|
+
[**get_attribute_id**](AttributesApi.html#get_attribute_id) | Get details about an existing attribute.
|
|
13
|
+
[**get_attributes**](AttributesApi.html#get_attributes) | Gets a list of existing attributes.
|
|
14
|
+
[**post_attributes**](AttributesApi.html#post_attributes) | Create an attribute.
|
|
15
|
+
[**post_query**](AttributesApi.html#post_query) | Query attributes
|
|
16
|
+
[**put_attribute_id**](AttributesApi.html#put_attribute_id) | Update an existing attribute.
|
|
17
17
|
{: class="table table-striped"}
|
|
18
18
|
|
|
19
19
|
<a name="delete_attribute_id"></a>
|
|
@@ -24,6 +24,9 @@ Delete an existing Attribute.
|
|
|
24
24
|
|
|
25
25
|
This will remove attribute.
|
|
26
26
|
|
|
27
|
+
Wraps DELETE /api/v2/attributes/{attributeId}
|
|
28
|
+
|
|
29
|
+
|
|
27
30
|
### Example
|
|
28
31
|
~~~ruby
|
|
29
32
|
# load the gem
|
|
@@ -79,6 +82,9 @@ Get details about an existing attribute.
|
|
|
79
82
|
|
|
80
83
|
|
|
81
84
|
|
|
85
|
+
Wraps GET /api/v2/attributes/{attributeId}
|
|
86
|
+
|
|
87
|
+
|
|
82
88
|
### Example
|
|
83
89
|
~~~ruby
|
|
84
90
|
# load the gem
|
|
@@ -135,6 +141,9 @@ Gets a list of existing attributes.
|
|
|
135
141
|
|
|
136
142
|
|
|
137
143
|
|
|
144
|
+
Wraps GET /api/v2/attributes
|
|
145
|
+
|
|
146
|
+
|
|
138
147
|
### Example
|
|
139
148
|
~~~ruby
|
|
140
149
|
# load the gem
|
|
@@ -194,6 +203,9 @@ Create an attribute.
|
|
|
194
203
|
|
|
195
204
|
|
|
196
205
|
|
|
206
|
+
Wraps POST /api/v2/attributes
|
|
207
|
+
|
|
208
|
+
|
|
197
209
|
### Example
|
|
198
210
|
~~~ruby
|
|
199
211
|
# load the gem
|
|
@@ -250,6 +262,9 @@ Query attributes
|
|
|
250
262
|
|
|
251
263
|
|
|
252
264
|
|
|
265
|
+
Wraps POST /api/v2/attributes/query
|
|
266
|
+
|
|
267
|
+
|
|
253
268
|
### Example
|
|
254
269
|
~~~ruby
|
|
255
270
|
# load the gem
|
|
@@ -306,6 +321,9 @@ Update an existing attribute.
|
|
|
306
321
|
|
|
307
322
|
Fields that can be updated: name, description. The most recent version is required for updates.
|
|
308
323
|
|
|
324
|
+
Wraps PUT /api/v2/attributes/{attributeId}
|
|
325
|
+
|
|
326
|
+
|
|
309
327
|
### Example
|
|
310
328
|
~~~ruby
|
|
311
329
|
# load the gem
|
|
@@ -6,25 +6,25 @@ title: AuthorizationApi
|
|
|
6
6
|
|
|
7
7
|
All URIs are relative to *https://api.mypurecloud.com*
|
|
8
8
|
|
|
9
|
-
Method |
|
|
9
|
+
Method | Description
|
|
10
10
|
------------- | ------------- | -------------
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
11
|
+
[**delete_roles_role_id**](AuthorizationApi.html#delete_roles_role_id) | Delete an organization role.
|
|
12
|
+
[**delete_user_id_roles**](AuthorizationApi.html#delete_user_id_roles) | Removes all the roles from the user.
|
|
13
|
+
[**get_permissions**](AuthorizationApi.html#get_permissions) | Get all permissions.
|
|
14
|
+
[**get_products**](AuthorizationApi.html#get_products) | Get the list of enabled products
|
|
15
|
+
[**get_roles**](AuthorizationApi.html#get_roles) | Retrieve a list of all roles defined for the organization
|
|
16
|
+
[**get_roles_leftrole_id_comparedefault_rightrole_id**](AuthorizationApi.html#get_roles_leftrole_id_comparedefault_rightrole_id) | Get an org role to default role comparison comparison
|
|
17
|
+
[**get_roles_role_id**](AuthorizationApi.html#get_roles_role_id) | Get a single organization role.
|
|
18
|
+
[**get_user_id_roles**](AuthorizationApi.html#get_user_id_roles) | Returns a listing of roles and permissions for a user.
|
|
19
|
+
[**patch_roles_role_id**](AuthorizationApi.html#patch_roles_role_id) | Patch Organization Role for needsUpdate Field
|
|
20
|
+
[**post_roles**](AuthorizationApi.html#post_roles) | Create an organization role.
|
|
21
|
+
[**post_roles_default**](AuthorizationApi.html#post_roles_default) | Restores all default roles
|
|
22
|
+
[**post_roles_leftrole_id_comparedefault_rightrole_id**](AuthorizationApi.html#post_roles_leftrole_id_comparedefault_rightrole_id) | Get an unsaved org role to default role comparison
|
|
23
|
+
[**put_roles_default**](AuthorizationApi.html#put_roles_default) | Restore specified default roles
|
|
24
|
+
[**put_roles_role_id**](AuthorizationApi.html#put_roles_role_id) | Update an organization role.
|
|
25
|
+
[**put_roles_role_id_users_add**](AuthorizationApi.html#put_roles_role_id_users_add) | Sets the users for the role
|
|
26
|
+
[**put_roles_role_id_users_remove**](AuthorizationApi.html#put_roles_role_id_users_remove) | Removes the users from the role
|
|
27
|
+
[**put_user_id_roles**](AuthorizationApi.html#put_user_id_roles) | Sets the user's roles
|
|
28
28
|
{: class="table table-striped"}
|
|
29
29
|
|
|
30
30
|
<a name="delete_roles_role_id"></a>
|
|
@@ -35,6 +35,9 @@ Delete an organization role.
|
|
|
35
35
|
|
|
36
36
|
|
|
37
37
|
|
|
38
|
+
Wraps DELETE /api/v2/authorization/roles/{roleId}
|
|
39
|
+
|
|
40
|
+
|
|
38
41
|
### Example
|
|
39
42
|
~~~ruby
|
|
40
43
|
# load the gem
|
|
@@ -90,6 +93,9 @@ Removes all the roles from the user.
|
|
|
90
93
|
|
|
91
94
|
|
|
92
95
|
|
|
96
|
+
Wraps DELETE /api/v2/users/{userId}/roles
|
|
97
|
+
|
|
98
|
+
|
|
93
99
|
### Example
|
|
94
100
|
~~~ruby
|
|
95
101
|
# load the gem
|
|
@@ -145,6 +151,9 @@ Get all permissions.
|
|
|
145
151
|
|
|
146
152
|
Retrieve a list of all permission defined in the system.
|
|
147
153
|
|
|
154
|
+
Wraps GET /api/v2/authorization/permissions
|
|
155
|
+
|
|
156
|
+
|
|
148
157
|
### Example
|
|
149
158
|
~~~ruby
|
|
150
159
|
# load the gem
|
|
@@ -204,6 +213,9 @@ Get the list of enabled products
|
|
|
204
213
|
|
|
205
214
|
Gets the list of enabled products. Some example product names are: collaborateFree, collaboratePro, communicate, and engage.
|
|
206
215
|
|
|
216
|
+
Wraps GET /api/v2/authorization/products
|
|
217
|
+
|
|
218
|
+
|
|
207
219
|
### Example
|
|
208
220
|
~~~ruby
|
|
209
221
|
# load the gem
|
|
@@ -254,6 +266,9 @@ Retrieve a list of all roles defined for the organization
|
|
|
254
266
|
|
|
255
267
|
|
|
256
268
|
|
|
269
|
+
Wraps GET /api/v2/authorization/roles
|
|
270
|
+
|
|
271
|
+
|
|
257
272
|
### Example
|
|
258
273
|
~~~ruby
|
|
259
274
|
# load the gem
|
|
@@ -325,6 +340,9 @@ Get an org role to default role comparison comparison
|
|
|
325
340
|
|
|
326
341
|
Compares any organization role to a default role id and show differences
|
|
327
342
|
|
|
343
|
+
Wraps GET /api/v2/authorization/roles/{leftRoleId}/comparedefault/{rightRoleId}
|
|
344
|
+
|
|
345
|
+
|
|
328
346
|
### Example
|
|
329
347
|
~~~ruby
|
|
330
348
|
# load the gem
|
|
@@ -384,6 +402,9 @@ Get a single organization role.
|
|
|
384
402
|
|
|
385
403
|
Get the organization role specified by its ID.
|
|
386
404
|
|
|
405
|
+
Wraps GET /api/v2/authorization/roles/{roleId}
|
|
406
|
+
|
|
407
|
+
|
|
387
408
|
### Example
|
|
388
409
|
~~~ruby
|
|
389
410
|
# load the gem
|
|
@@ -440,6 +461,9 @@ Returns a listing of roles and permissions for a user.
|
|
|
440
461
|
|
|
441
462
|
|
|
442
463
|
|
|
464
|
+
Wraps GET /api/v2/users/{userId}/roles
|
|
465
|
+
|
|
466
|
+
|
|
443
467
|
### Example
|
|
444
468
|
~~~ruby
|
|
445
469
|
# load the gem
|
|
@@ -496,6 +520,9 @@ Patch Organization Role for needsUpdate Field
|
|
|
496
520
|
|
|
497
521
|
Patch Organization Role for needsUpdate Field
|
|
498
522
|
|
|
523
|
+
Wraps PATCH /api/v2/authorization/roles/{roleId}
|
|
524
|
+
|
|
525
|
+
|
|
499
526
|
### Example
|
|
500
527
|
~~~ruby
|
|
501
528
|
# load the gem
|
|
@@ -555,6 +582,9 @@ Create an organization role.
|
|
|
555
582
|
|
|
556
583
|
|
|
557
584
|
|
|
585
|
+
Wraps POST /api/v2/authorization/roles
|
|
586
|
+
|
|
587
|
+
|
|
558
588
|
### Example
|
|
559
589
|
~~~ruby
|
|
560
590
|
# load the gem
|
|
@@ -611,6 +641,9 @@ Restores all default roles
|
|
|
611
641
|
|
|
612
642
|
This endpoint serves several purposes. 1. It provides the org with default roles. This is important for default roles that will be added after go-live (they can retroactively add the new default-role). Note: When not using a query param of force=true, it only adds the default roles not configured for the org; it does not overwrite roles. 2. Using the query param force=true, you can restore all default roles. Note: This does not have an effect on custom roles.
|
|
613
643
|
|
|
644
|
+
Wraps POST /api/v2/authorization/roles/default
|
|
645
|
+
|
|
646
|
+
|
|
614
647
|
### Example
|
|
615
648
|
~~~ruby
|
|
616
649
|
# load the gem
|
|
@@ -668,6 +701,9 @@ Get an unsaved org role to default role comparison
|
|
|
668
701
|
|
|
669
702
|
Allows users to compare their existing roles in an unsaved state to its default role
|
|
670
703
|
|
|
704
|
+
Wraps POST /api/v2/authorization/roles/{leftRoleId}/comparedefault/{rightRoleId}
|
|
705
|
+
|
|
706
|
+
|
|
671
707
|
### Example
|
|
672
708
|
~~~ruby
|
|
673
709
|
# load the gem
|
|
@@ -730,6 +766,9 @@ Restore specified default roles
|
|
|
730
766
|
|
|
731
767
|
|
|
732
768
|
|
|
769
|
+
Wraps PUT /api/v2/authorization/roles/default
|
|
770
|
+
|
|
771
|
+
|
|
733
772
|
### Example
|
|
734
773
|
~~~ruby
|
|
735
774
|
# load the gem
|
|
@@ -786,6 +825,9 @@ Update an organization role.
|
|
|
786
825
|
|
|
787
826
|
Update
|
|
788
827
|
|
|
828
|
+
Wraps PUT /api/v2/authorization/roles/{roleId}
|
|
829
|
+
|
|
830
|
+
|
|
789
831
|
### Example
|
|
790
832
|
~~~ruby
|
|
791
833
|
# load the gem
|
|
@@ -845,6 +887,9 @@ Sets the users for the role
|
|
|
845
887
|
|
|
846
888
|
|
|
847
889
|
|
|
890
|
+
Wraps PUT /api/v2/authorization/roles/{roleId}/users/add
|
|
891
|
+
|
|
892
|
+
|
|
848
893
|
### Example
|
|
849
894
|
~~~ruby
|
|
850
895
|
# load the gem
|
|
@@ -904,6 +949,9 @@ Removes the users from the role
|
|
|
904
949
|
|
|
905
950
|
|
|
906
951
|
|
|
952
|
+
Wraps PUT /api/v2/authorization/roles/{roleId}/users/remove
|
|
953
|
+
|
|
954
|
+
|
|
907
955
|
### Example
|
|
908
956
|
~~~ruby
|
|
909
957
|
# load the gem
|
|
@@ -963,6 +1011,9 @@ Sets the user's roles
|
|
|
963
1011
|
|
|
964
1012
|
|
|
965
1013
|
|
|
1014
|
+
Wraps PUT /api/v2/users/{userId}/roles
|
|
1015
|
+
|
|
1016
|
+
|
|
966
1017
|
### Example
|
|
967
1018
|
~~~ruby
|
|
968
1019
|
# load the gem
|