purecloud 0.67.1 → 0.68.1
Sign up to get free protection for your applications and to get access to all the features.
- 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
|
@@ -11,11 +11,11 @@ title: OutboundRouteBaseEntityListing
|
|
|
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
|
|
|
@@ -11,11 +11,11 @@ title: OutboundRouteEntityListing
|
|
|
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
|
|
|
@@ -11,11 +11,11 @@ title: PermissionCollectionEntityListing
|
|
|
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
|
|
|
@@ -11,11 +11,11 @@ title: PhoneBaseEntityListing
|
|
|
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
|
|
|
@@ -11,11 +11,11 @@ title: PhoneEntityListing
|
|
|
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
|
|
|
@@ -11,11 +11,11 @@ title: PhoneMetaBaseEntityListing
|
|
|
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
|
|
|
@@ -11,11 +11,11 @@ title: PhysicalInterfaceEntityListing
|
|
|
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
|
|
|
@@ -11,11 +11,11 @@ title: PolicyEntityListing
|
|
|
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
|
|
data/doc_out/PresenceApi.html.md
CHANGED
|
@@ -6,16 +6,16 @@ title: PresenceApi
|
|
|
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
|
-
|
|
11
|
+
[**delete_presence_id**](PresenceApi.html#delete_presence_id) | Delete a Presence Definition
|
|
12
|
+
[**get_presence_id**](PresenceApi.html#get_presence_id) | Get a Presence Definition
|
|
13
|
+
[**get_presencedefinitions**](PresenceApi.html#get_presencedefinitions) | Get an Organization's list of Presence Definitions
|
|
14
|
+
[**get_systempresences**](PresenceApi.html#get_systempresences) | Get the list of SystemPresences
|
|
15
|
+
[**get_user_id_presences_source_id**](PresenceApi.html#get_user_id_presences_source_id) | Get a user's Presence
|
|
16
|
+
[**patch_user_id_presences_source_id**](PresenceApi.html#patch_user_id_presences_source_id) | Patch a user's Presence
|
|
17
|
+
[**post_presencedefinitions**](PresenceApi.html#post_presencedefinitions) | Create a Presence Definition
|
|
18
|
+
[**put_presence_id**](PresenceApi.html#put_presence_id) | Update a Presence Definition
|
|
19
19
|
{: class="table table-striped"}
|
|
20
20
|
|
|
21
21
|
<a name="delete_presence_id"></a>
|
|
@@ -26,6 +26,9 @@ Delete a Presence Definition
|
|
|
26
26
|
|
|
27
27
|
|
|
28
28
|
|
|
29
|
+
Wraps DELETE /api/v2/presencedefinitions/{presenceId}
|
|
30
|
+
|
|
31
|
+
|
|
29
32
|
### Example
|
|
30
33
|
~~~ruby
|
|
31
34
|
# load the gem
|
|
@@ -81,6 +84,9 @@ Get a Presence Definition
|
|
|
81
84
|
|
|
82
85
|
|
|
83
86
|
|
|
87
|
+
Wraps GET /api/v2/presencedefinitions/{presenceId}
|
|
88
|
+
|
|
89
|
+
|
|
84
90
|
### Example
|
|
85
91
|
~~~ruby
|
|
86
92
|
# load the gem
|
|
@@ -141,6 +147,9 @@ Get an Organization's list of Presence Definitions
|
|
|
141
147
|
|
|
142
148
|
|
|
143
149
|
|
|
150
|
+
Wraps GET /api/v2/presencedefinitions
|
|
151
|
+
|
|
152
|
+
|
|
144
153
|
### Example
|
|
145
154
|
~~~ruby
|
|
146
155
|
# load the gem
|
|
@@ -204,6 +213,9 @@ Get the list of SystemPresences
|
|
|
204
213
|
|
|
205
214
|
|
|
206
215
|
|
|
216
|
+
Wraps GET /api/v2/systempresences
|
|
217
|
+
|
|
218
|
+
|
|
207
219
|
### Example
|
|
208
220
|
~~~ruby
|
|
209
221
|
# load the gem
|
|
@@ -254,6 +266,9 @@ Get a user's Presence
|
|
|
254
266
|
|
|
255
267
|
|
|
256
268
|
|
|
269
|
+
Wraps GET /api/v2/users/{userId}/presences/{sourceId}
|
|
270
|
+
|
|
271
|
+
|
|
257
272
|
### Example
|
|
258
273
|
~~~ruby
|
|
259
274
|
# load the gem
|
|
@@ -313,6 +328,9 @@ Patch a user's Presence
|
|
|
313
328
|
|
|
314
329
|
The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the 'source' defined in the path as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.
|
|
315
330
|
|
|
331
|
+
Wraps PATCH /api/v2/users/{userId}/presences/{sourceId}
|
|
332
|
+
|
|
333
|
+
|
|
316
334
|
### Example
|
|
317
335
|
~~~ruby
|
|
318
336
|
# load the gem
|
|
@@ -375,6 +393,9 @@ Create a Presence Definition
|
|
|
375
393
|
|
|
376
394
|
|
|
377
395
|
|
|
396
|
+
Wraps POST /api/v2/presencedefinitions
|
|
397
|
+
|
|
398
|
+
|
|
378
399
|
### Example
|
|
379
400
|
~~~ruby
|
|
380
401
|
# load the gem
|
|
@@ -431,6 +452,9 @@ Update a Presence Definition
|
|
|
431
452
|
|
|
432
453
|
|
|
433
454
|
|
|
455
|
+
Wraps PUT /api/v2/presencedefinitions/{presenceId}
|
|
456
|
+
|
|
457
|
+
|
|
434
458
|
### Example
|
|
435
459
|
~~~ruby
|
|
436
460
|
# load the gem
|
data/doc_out/QualityApi.html.md
CHANGED
|
@@ -6,39 +6,39 @@ title: QualityApi
|
|
|
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
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
11
|
+
[**delete_calibrations_calibration_id**](QualityApi.html#delete_calibrations_calibration_id) | Delete a calibration by id.
|
|
12
|
+
[**delete_conversations_conversation_id_evaluations_evaluation_id**](QualityApi.html#delete_conversations_conversation_id_evaluations_evaluation_id) | Delete an evaluation
|
|
13
|
+
[**delete_forms_form_id**](QualityApi.html#delete_forms_form_id) | Delete an evaluation form.
|
|
14
|
+
[**delete_keywordsets**](QualityApi.html#delete_keywordsets) | Delete keyword sets
|
|
15
|
+
[**delete_keywordsets_keywordset_id**](QualityApi.html#delete_keywordsets_keywordset_id) | Delete a keywordSet by id.
|
|
16
|
+
[**get_agents_activity**](QualityApi.html#get_agents_activity) | Gets a list of Agent Activities
|
|
17
|
+
[**get_calibrations**](QualityApi.html#get_calibrations) | Get the list of calibrations
|
|
18
|
+
[**get_calibrations_calibration_id**](QualityApi.html#get_calibrations_calibration_id) | Get a calibration by id.
|
|
19
|
+
[**get_conversations_conversation_id_audits**](QualityApi.html#get_conversations_conversation_id_audits) | Get audits for conversation or recording
|
|
20
|
+
[**get_conversations_conversation_id_evaluations_evaluation_id**](QualityApi.html#get_conversations_conversation_id_evaluations_evaluation_id) | Get an evaluation
|
|
21
|
+
[**get_evaluations_query**](QualityApi.html#get_evaluations_query) | Queries Evaluations and returns a paged list
|
|
22
|
+
[**get_evaluators_activity**](QualityApi.html#get_evaluators_activity) | Get an evaluator activity
|
|
23
|
+
[**get_forms**](QualityApi.html#get_forms) | Get the list of evaluation forms
|
|
24
|
+
[**get_forms_form_id**](QualityApi.html#get_forms_form_id) | Get an evaluation form
|
|
25
|
+
[**get_forms_form_id_versions**](QualityApi.html#get_forms_form_id_versions) | Gets all the revisions for a specific evaluation.
|
|
26
|
+
[**get_keywordsets**](QualityApi.html#get_keywordsets) | Get the list of keyword sets
|
|
27
|
+
[**get_keywordsets_keywordset_id**](QualityApi.html#get_keywordsets_keywordset_id) | Get a keywordSet by id.
|
|
28
|
+
[**get_publishedforms**](QualityApi.html#get_publishedforms) | Get the published evaluation forms.
|
|
29
|
+
[**get_publishedforms_form_id**](QualityApi.html#get_publishedforms_form_id) | Get the published evaluation forms.
|
|
30
|
+
[**post_calibrations**](QualityApi.html#post_calibrations) | Create a calibration
|
|
31
|
+
[**post_conversations_conversation_id_evaluations**](QualityApi.html#post_conversations_conversation_id_evaluations) | Create an evaluation
|
|
32
|
+
[**post_evaluations_aggregates_query**](QualityApi.html#post_evaluations_aggregates_query) | Query for evaluation aggregates
|
|
33
|
+
[**post_evaluations_scoring**](QualityApi.html#post_evaluations_scoring) | Score evaluation
|
|
34
|
+
[**post_forms**](QualityApi.html#post_forms) | Create an evaluation form.
|
|
35
|
+
[**post_keywordsets**](QualityApi.html#post_keywordsets) | Create a Keyword Set
|
|
36
|
+
[**post_publishedforms**](QualityApi.html#post_publishedforms) | Publish an evaluation form.
|
|
37
|
+
[**post_spotability**](QualityApi.html#post_spotability) | Retrieve the spotability statistic
|
|
38
|
+
[**put_calibrations_calibration_id**](QualityApi.html#put_calibrations_calibration_id) | Update a calibration to the specified calibration via PUT. Editable fields include: evaluators, expertEvaluator, and scoringIndex
|
|
39
|
+
[**put_conversations_conversation_id_evaluations_evaluation_id**](QualityApi.html#put_conversations_conversation_id_evaluations_evaluation_id) | Update an evaluation
|
|
40
|
+
[**put_forms_form_id**](QualityApi.html#put_forms_form_id) | Update an evaluation form.
|
|
41
|
+
[**put_keywordsets_keywordset_id**](QualityApi.html#put_keywordsets_keywordset_id) | Update a keywordSet to the specified keywordSet via PUT.
|
|
42
42
|
{: class="table table-striped"}
|
|
43
43
|
|
|
44
44
|
<a name="delete_calibrations_calibration_id"></a>
|
|
@@ -49,6 +49,9 @@ Delete a calibration by id.
|
|
|
49
49
|
|
|
50
50
|
|
|
51
51
|
|
|
52
|
+
Wraps DELETE /api/v2/quality/calibrations/{calibrationId}
|
|
53
|
+
|
|
54
|
+
|
|
52
55
|
### Example
|
|
53
56
|
~~~ruby
|
|
54
57
|
# load the gem
|
|
@@ -108,6 +111,9 @@ Delete an evaluation
|
|
|
108
111
|
|
|
109
112
|
|
|
110
113
|
|
|
114
|
+
Wraps DELETE /api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId}
|
|
115
|
+
|
|
116
|
+
|
|
111
117
|
### Example
|
|
112
118
|
~~~ruby
|
|
113
119
|
# load the gem
|
|
@@ -171,6 +177,9 @@ Delete an evaluation form.
|
|
|
171
177
|
|
|
172
178
|
|
|
173
179
|
|
|
180
|
+
Wraps DELETE /api/v2/quality/forms/{formId}
|
|
181
|
+
|
|
182
|
+
|
|
174
183
|
### Example
|
|
175
184
|
~~~ruby
|
|
176
185
|
# load the gem
|
|
@@ -227,6 +236,9 @@ Delete keyword sets
|
|
|
227
236
|
|
|
228
237
|
Bulk delete of keyword sets; this will only delete the keyword sets that match the ids specified in the query param.
|
|
229
238
|
|
|
239
|
+
Wraps DELETE /api/v2/quality/keywordsets
|
|
240
|
+
|
|
241
|
+
|
|
230
242
|
### Example
|
|
231
243
|
~~~ruby
|
|
232
244
|
# load the gem
|
|
@@ -283,6 +295,9 @@ Delete a keywordSet by id.
|
|
|
283
295
|
|
|
284
296
|
|
|
285
297
|
|
|
298
|
+
Wraps DELETE /api/v2/quality/keywordsets/{keywordSetId}
|
|
299
|
+
|
|
300
|
+
|
|
286
301
|
### Example
|
|
287
302
|
~~~ruby
|
|
288
303
|
# load the gem
|
|
@@ -338,6 +353,9 @@ Gets a list of Agent Activities
|
|
|
338
353
|
|
|
339
354
|
Including the number of evaluations and average evaluation score
|
|
340
355
|
|
|
356
|
+
Wraps GET /api/v2/quality/agents/activity
|
|
357
|
+
|
|
358
|
+
|
|
341
359
|
### Example
|
|
342
360
|
~~~ruby
|
|
343
361
|
# load the gem
|
|
@@ -417,6 +435,9 @@ Get the list of calibrations
|
|
|
417
435
|
|
|
418
436
|
|
|
419
437
|
|
|
438
|
+
Wraps GET /api/v2/quality/calibrations
|
|
439
|
+
|
|
440
|
+
|
|
420
441
|
### Example
|
|
421
442
|
~~~ruby
|
|
422
443
|
# load the gem
|
|
@@ -493,6 +514,9 @@ Get a calibration by id.
|
|
|
493
514
|
|
|
494
515
|
|
|
495
516
|
|
|
517
|
+
Wraps GET /api/v2/quality/calibrations/{calibrationId}
|
|
518
|
+
|
|
519
|
+
|
|
496
520
|
### Example
|
|
497
521
|
~~~ruby
|
|
498
522
|
# load the gem
|
|
@@ -552,6 +576,9 @@ Get audits for conversation or recording
|
|
|
552
576
|
|
|
553
577
|
|
|
554
578
|
|
|
579
|
+
Wraps GET /api/v2/quality/conversations/{conversationId}/audits
|
|
580
|
+
|
|
581
|
+
|
|
555
582
|
### Example
|
|
556
583
|
~~~ruby
|
|
557
584
|
# load the gem
|
|
@@ -626,6 +653,9 @@ Get an evaluation
|
|
|
626
653
|
|
|
627
654
|
|
|
628
655
|
|
|
656
|
+
Wraps GET /api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId}
|
|
657
|
+
|
|
658
|
+
|
|
629
659
|
### Example
|
|
630
660
|
~~~ruby
|
|
631
661
|
# load the gem
|
|
@@ -689,6 +719,9 @@ Queries Evaluations and returns a paged list
|
|
|
689
719
|
|
|
690
720
|
Query params must include one of conversationId, evaluatorUserId, or agentUserId
|
|
691
721
|
|
|
722
|
+
Wraps GET /api/v2/quality/evaluations/query
|
|
723
|
+
|
|
724
|
+
|
|
692
725
|
### Example
|
|
693
726
|
~~~ruby
|
|
694
727
|
# load the gem
|
|
@@ -778,6 +811,9 @@ Get an evaluator activity
|
|
|
778
811
|
|
|
779
812
|
|
|
780
813
|
|
|
814
|
+
Wraps GET /api/v2/quality/evaluators/activity
|
|
815
|
+
|
|
816
|
+
|
|
781
817
|
### Example
|
|
782
818
|
~~~ruby
|
|
783
819
|
# load the gem
|
|
@@ -855,6 +891,9 @@ Get the list of evaluation forms
|
|
|
855
891
|
|
|
856
892
|
|
|
857
893
|
|
|
894
|
+
Wraps GET /api/v2/quality/forms
|
|
895
|
+
|
|
896
|
+
|
|
858
897
|
### Example
|
|
859
898
|
~~~ruby
|
|
860
899
|
# load the gem
|
|
@@ -924,6 +963,9 @@ Get an evaluation form
|
|
|
924
963
|
|
|
925
964
|
|
|
926
965
|
|
|
966
|
+
Wraps GET /api/v2/quality/forms/{formId}
|
|
967
|
+
|
|
968
|
+
|
|
927
969
|
### Example
|
|
928
970
|
~~~ruby
|
|
929
971
|
# load the gem
|
|
@@ -980,6 +1022,9 @@ Gets all the revisions for a specific evaluation.
|
|
|
980
1022
|
|
|
981
1023
|
|
|
982
1024
|
|
|
1025
|
+
Wraps GET /api/v2/quality/forms/{formId}/versions
|
|
1026
|
+
|
|
1027
|
+
|
|
983
1028
|
### Example
|
|
984
1029
|
~~~ruby
|
|
985
1030
|
# load the gem
|
|
@@ -1042,6 +1087,9 @@ Get the list of keyword sets
|
|
|
1042
1087
|
|
|
1043
1088
|
|
|
1044
1089
|
|
|
1090
|
+
Wraps GET /api/v2/quality/keywordsets
|
|
1091
|
+
|
|
1092
|
+
|
|
1045
1093
|
### Example
|
|
1046
1094
|
~~~ruby
|
|
1047
1095
|
# load the gem
|
|
@@ -1068,7 +1116,8 @@ opts = {
|
|
|
1068
1116
|
previous_page: "previous_page_example", # String | Previous page token
|
|
1069
1117
|
name: "name_example", # String | the keyword set name - used for filtering results in searches.
|
|
1070
1118
|
queue_id: "queue_id_example", # String | the queue id - used for filtering results in searches.
|
|
1071
|
-
agent_id: "agent_id_example" # String | the agent id - used for filtering results in searches.
|
|
1119
|
+
agent_id: "agent_id_example", # String | the agent id - used for filtering results in searches.
|
|
1120
|
+
operator: "operator_example" # String | If agentID and queueId are both present, this determines whether the query is an AND or OR between those parameters.
|
|
1072
1121
|
}
|
|
1073
1122
|
|
|
1074
1123
|
begin
|
|
@@ -1093,6 +1142,7 @@ Name | Type | Description | Notes
|
|
|
1093
1142
|
**name** | **String**| the keyword set name - used for filtering results in searches. | [optional]
|
|
1094
1143
|
**queue_id** | **String**| the queue id - used for filtering results in searches. | [optional]
|
|
1095
1144
|
**agent_id** | **String**| the agent id - used for filtering results in searches. | [optional]
|
|
1145
|
+
**operator** | **String**| If agentID and queueId are both present, this determines whether the query is an AND or OR between those parameters. | [optional]
|
|
1096
1146
|
{: class="table table-striped"}
|
|
1097
1147
|
|
|
1098
1148
|
|
|
@@ -1115,6 +1165,9 @@ Get a keywordSet by id.
|
|
|
1115
1165
|
|
|
1116
1166
|
|
|
1117
1167
|
|
|
1168
|
+
Wraps GET /api/v2/quality/keywordsets/{keywordSetId}
|
|
1169
|
+
|
|
1170
|
+
|
|
1118
1171
|
### Example
|
|
1119
1172
|
~~~ruby
|
|
1120
1173
|
# load the gem
|
|
@@ -1171,6 +1224,9 @@ Get the published evaluation forms.
|
|
|
1171
1224
|
|
|
1172
1225
|
|
|
1173
1226
|
|
|
1227
|
+
Wraps GET /api/v2/quality/publishedforms
|
|
1228
|
+
|
|
1229
|
+
|
|
1174
1230
|
### Example
|
|
1175
1231
|
~~~ruby
|
|
1176
1232
|
# load the gem
|
|
@@ -1232,6 +1288,9 @@ Get the published evaluation forms.
|
|
|
1232
1288
|
|
|
1233
1289
|
|
|
1234
1290
|
|
|
1291
|
+
Wraps GET /api/v2/quality/publishedforms/{formId}
|
|
1292
|
+
|
|
1293
|
+
|
|
1235
1294
|
### Example
|
|
1236
1295
|
~~~ruby
|
|
1237
1296
|
# load the gem
|
|
@@ -1288,6 +1347,9 @@ Create a calibration
|
|
|
1288
1347
|
|
|
1289
1348
|
|
|
1290
1349
|
|
|
1350
|
+
Wraps POST /api/v2/quality/calibrations
|
|
1351
|
+
|
|
1352
|
+
|
|
1291
1353
|
### Example
|
|
1292
1354
|
~~~ruby
|
|
1293
1355
|
# load the gem
|
|
@@ -1348,6 +1410,9 @@ Create an evaluation
|
|
|
1348
1410
|
|
|
1349
1411
|
|
|
1350
1412
|
|
|
1413
|
+
Wraps POST /api/v2/quality/conversations/{conversationId}/evaluations
|
|
1414
|
+
|
|
1415
|
+
|
|
1351
1416
|
### Example
|
|
1352
1417
|
~~~ruby
|
|
1353
1418
|
# load the gem
|
|
@@ -1411,6 +1476,9 @@ Query for evaluation aggregates
|
|
|
1411
1476
|
|
|
1412
1477
|
|
|
1413
1478
|
|
|
1479
|
+
Wraps POST /api/v2/analytics/evaluations/aggregates/query
|
|
1480
|
+
|
|
1481
|
+
|
|
1414
1482
|
### Example
|
|
1415
1483
|
~~~ruby
|
|
1416
1484
|
# load the gem
|
|
@@ -1467,6 +1535,9 @@ Score evaluation
|
|
|
1467
1535
|
|
|
1468
1536
|
|
|
1469
1537
|
|
|
1538
|
+
Wraps POST /api/v2/quality/evaluations/scoring
|
|
1539
|
+
|
|
1540
|
+
|
|
1470
1541
|
### Example
|
|
1471
1542
|
~~~ruby
|
|
1472
1543
|
# load the gem
|
|
@@ -1523,6 +1594,9 @@ Create an evaluation form.
|
|
|
1523
1594
|
|
|
1524
1595
|
|
|
1525
1596
|
|
|
1597
|
+
Wraps POST /api/v2/quality/forms
|
|
1598
|
+
|
|
1599
|
+
|
|
1526
1600
|
### Example
|
|
1527
1601
|
~~~ruby
|
|
1528
1602
|
# load the gem
|
|
@@ -1579,6 +1653,9 @@ Create a Keyword Set
|
|
|
1579
1653
|
|
|
1580
1654
|
|
|
1581
1655
|
|
|
1656
|
+
Wraps POST /api/v2/quality/keywordsets
|
|
1657
|
+
|
|
1658
|
+
|
|
1582
1659
|
### Example
|
|
1583
1660
|
~~~ruby
|
|
1584
1661
|
# load the gem
|
|
@@ -1639,6 +1716,9 @@ Publish an evaluation form.
|
|
|
1639
1716
|
|
|
1640
1717
|
|
|
1641
1718
|
|
|
1719
|
+
Wraps POST /api/v2/quality/publishedforms
|
|
1720
|
+
|
|
1721
|
+
|
|
1642
1722
|
### Example
|
|
1643
1723
|
~~~ruby
|
|
1644
1724
|
# load the gem
|
|
@@ -1695,6 +1775,9 @@ Retrieve the spotability statistic
|
|
|
1695
1775
|
|
|
1696
1776
|
|
|
1697
1777
|
|
|
1778
|
+
Wraps POST /api/v2/quality/spotability
|
|
1779
|
+
|
|
1780
|
+
|
|
1698
1781
|
### Example
|
|
1699
1782
|
~~~ruby
|
|
1700
1783
|
# load the gem
|
|
@@ -1752,6 +1835,9 @@ Update a calibration to the specified calibration via PUT. Editable fields incl
|
|
|
1752
1835
|
|
|
1753
1836
|
|
|
1754
1837
|
|
|
1838
|
+
Wraps PUT /api/v2/quality/calibrations/{calibrationId}
|
|
1839
|
+
|
|
1840
|
+
|
|
1755
1841
|
### Example
|
|
1756
1842
|
~~~ruby
|
|
1757
1843
|
# load the gem
|
|
@@ -1811,6 +1897,9 @@ Update an evaluation
|
|
|
1811
1897
|
|
|
1812
1898
|
|
|
1813
1899
|
|
|
1900
|
+
Wraps PUT /api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId}
|
|
1901
|
+
|
|
1902
|
+
|
|
1814
1903
|
### Example
|
|
1815
1904
|
~~~ruby
|
|
1816
1905
|
# load the gem
|
|
@@ -1877,6 +1966,9 @@ Update an evaluation form.
|
|
|
1877
1966
|
|
|
1878
1967
|
|
|
1879
1968
|
|
|
1969
|
+
Wraps PUT /api/v2/quality/forms/{formId}
|
|
1970
|
+
|
|
1971
|
+
|
|
1880
1972
|
### Example
|
|
1881
1973
|
~~~ruby
|
|
1882
1974
|
# load the gem
|
|
@@ -1936,6 +2028,9 @@ Update a keywordSet to the specified keywordSet via PUT.
|
|
|
1936
2028
|
|
|
1937
2029
|
|
|
1938
2030
|
|
|
2031
|
+
Wraps PUT /api/v2/quality/keywordsets/{keywordSetId}
|
|
2032
|
+
|
|
2033
|
+
|
|
1939
2034
|
### Example
|
|
1940
2035
|
~~~ruby
|
|
1941
2036
|
# load the gem
|