purecloud 0.64.1 → 0.65.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 +68 -0
- data/config-ruby.json +1 -1
- data/doc_out/ADFS.html.md +1 -1
- data/doc_out/AgentActivityEntityListing.html.md +2 -2
- data/doc_out/AggregationQuery.html.md +1 -1
- data/doc_out/AnalyticsConversation.html.md +1 -0
- data/doc_out/AnalyticsConversationSegment.html.md +3 -3
- data/doc_out/AnalyticsSession.html.md +2 -2
- data/doc_out/AttemptLimitsEntityListing.html.md +2 -2
- data/doc_out/AttemptLimitsNotification.html.md +23 -0
- data/doc_out/AttemptLimitsNotificationRecallEntries.html.md +15 -0
- data/doc_out/AttemptLimitsNotificationRecallEntry.html.md +15 -0
- data/doc_out/AttributeEntityListing.html.md +2 -2
- data/doc_out/AuditMessage.html.md +1 -1
- data/doc_out/CalibrationEntityListing.html.md +2 -2
- data/doc_out/Call.html.md +4 -4
- data/doc_out/CallConversationEntityListing.html.md +2 -2
- data/doc_out/CallForwarding.html.md +1 -1
- data/doc_out/CallMediaParticipant.html.md +6 -6
- data/doc_out/CallableTimeSetEntityListing.html.md +2 -2
- data/doc_out/CallableTimeSetNotification.html.md +19 -0
- data/doc_out/CallableTimeSetNotificationCallableTime.html.md +15 -0
- data/doc_out/CallableTimeSetNotificationCallableTimes.html.md +15 -0
- data/doc_out/CallableTimeSetNotificationTimeSlot.html.md +16 -0
- data/doc_out/CallableTimeSetNotificationTimeSlots.html.md +16 -0
- data/doc_out/Callback.html.md +3 -2
- data/doc_out/CallbackConversationEntityListing.html.md +2 -2
- data/doc_out/CallbackConversationNotificationDialerPreview.html.md +1 -1
- data/doc_out/CallbackMediaParticipant.html.md +5 -4
- data/doc_out/Campaign.html.md +1 -1
- data/doc_out/CampaignEntityListing.html.md +2 -2
- data/doc_out/CampaignInteraction.html.md +1 -1
- data/doc_out/CampaignNotification.html.md +41 -0
- data/doc_out/CampaignNotificationContactSort.html.md +16 -0
- data/doc_out/CampaignNotificationError.html.md +15 -0
- data/doc_out/CampaignNotificationErrors.html.md +15 -0
- data/doc_out/{ConversationNotificationDialerPreviewPhoneNumberColumns.html.md → CampaignNotificationPhoneColumn.html.md} +3 -3
- data/doc_out/CampaignNotificationPhoneColumns.html.md +15 -0
- data/doc_out/CampaignNotificationUriReference.html.md +14 -0
- data/doc_out/CampaignProgressNotification.html.md +17 -0
- data/doc_out/CampaignProgressNotificationUriReference.html.md +14 -0
- data/doc_out/CampaignRule.html.md +2 -2
- data/doc_out/CampaignRuleActionEntities.html.md +1 -1
- data/doc_out/CampaignRuleEntityListing.html.md +2 -2
- data/doc_out/CampaignRuleNotification.html.md +23 -0
- data/doc_out/CampaignRuleNotificationCampaignRuleAction.html.md +17 -0
- data/doc_out/CampaignRuleNotificationCampaignRuleActionEntities.html.md +16 -0
- data/doc_out/CampaignRuleNotificationCampaignRuleActions.html.md +17 -0
- data/doc_out/CampaignRuleNotificationCampaignRuleCondition.html.md +16 -0
- data/doc_out/CampaignRuleNotificationCampaignRuleConditions.html.md +16 -0
- data/doc_out/CampaignRuleNotificationCampaignRuleEntities.html.md +15 -0
- data/doc_out/CampaignScheduleNotification.html.md +21 -0
- data/doc_out/CampaignScheduleNotificationIntervals.html.md +15 -0
- data/doc_out/CampaignScheduleNotificationScheduleInterval.html.md +15 -0
- data/doc_out/CampaignScheduleNotificationUriReference.html.md +14 -0
- data/doc_out/CampaignSequence.html.md +1 -1
- data/doc_out/CampaignSequenceEntityListing.html.md +2 -2
- data/doc_out/CampaignSequenceNotification.html.md +23 -0
- data/doc_out/CampaignSequenceNotificationUriReference.html.md +14 -0
- data/doc_out/CertificateAuthorityEntityListing.html.md +2 -2
- data/doc_out/CertificateDetails.html.md +3 -3
- data/doc_out/ChannelEntityListing.html.md +2 -2
- data/doc_out/ChatConversationEntityListing.html.md +2 -2
- data/doc_out/ChatMediaParticipant.html.md +3 -3
- data/doc_out/CobrowseConversationEntityListing.html.md +2 -2
- data/doc_out/CobrowseMediaParticipant.html.md +3 -3
- data/doc_out/CommandStatusEntityListing.html.md +2 -2
- data/doc_out/Condition.html.md +1 -1
- data/doc_out/ContactListEntityListing.html.md +2 -2
- data/doc_out/ContactListNotification.html.md +25 -0
- data/doc_out/ContactListNotificationImportStatus.html.md +18 -0
- data/doc_out/ContactListNotificationPhoneColumn_.html.md +16 -0
- data/doc_out/ContactListNotificationPhoneColumns.html.md +16 -0
- data/doc_out/ContactListNotificationUriReference.html.md +14 -0
- data/doc_out/ContactSort.html.md +1 -1
- data/doc_out/ContentQueryRequest.html.md +1 -1
- data/doc_out/ContentSortItem.html.md +1 -1
- data/doc_out/ConversationChat.html.md +1 -1
- data/doc_out/ConversationEntityListing.html.md +2 -2
- data/doc_out/ConversationNotificationDialerPreview.html.md +1 -1
- data/doc_out/CurrentUserScheduleRequestBody.html.md +14 -0
- data/doc_out/CustomerInteractionCenter.html.md +1 -1
- 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/DialerContact.html.md +1 -1
- data/doc_out/DncListEntityListing.html.md +2 -2
- data/doc_out/DncListNotification.html.md +24 -0
- data/doc_out/DncListNotificationImportStatus.html.md +18 -0
- data/doc_out/Document.html.md +1 -1
- data/doc_out/DocumentAudit.html.md +1 -1
- data/doc_out/DocumentAuditEntityListing.html.md +2 -2
- data/doc_out/DocumentEntityListing.html.md +2 -2
- data/doc_out/DocumentUpdate.html.md +1 -1
- data/doc_out/DomainCapabilities.html.md +4 -4
- data/doc_out/DomainEdgeSoftwareUpdateDto.html.md +2 -2
- data/doc_out/DomainEdgeSoftwareVersionDto.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/DomainLogicalInterface.html.md +3 -3
- data/doc_out/DomainNetworkAddress.html.md +1 -1
- data/doc_out/DomainNetworkCommandResponse.html.md +1 -1
- data/doc_out/DomainNetworkRoute.html.md +1 -1
- data/doc_out/DomainOrganizationRole.html.md +3 -3
- data/doc_out/DomainOrganizationRoleCreate.html.md +3 -3
- data/doc_out/DomainOrganizationRoleUpdate.html.md +3 -3
- data/doc_out/DomainPermission.html.md +1 -1
- data/doc_out/DomainPermissionPolicy.html.md +1 -1
- data/doc_out/DomainPhysicalCapabilities.html.md +2 -2
- data/doc_out/Edge.html.md +2 -2
- data/doc_out/EdgeAutoUpdateConfig.html.md +2 -2
- data/doc_out/EdgeEntityListing.html.md +2 -2
- data/doc_out/EdgeGroup.html.md +1 -1
- data/doc_out/EdgeGroupEntityListing.html.md +2 -2
- data/doc_out/EdgeLineEntityListing.html.md +2 -2
- data/doc_out/EdgeLogsJobRequest.html.md +1 -1
- data/doc_out/Email.html.md +1 -1
- data/doc_out/EmailConversationEntityListing.html.md +2 -2
- data/doc_out/EmailMediaParticipant.html.md +3 -3
- data/doc_out/EmailMessageListing.html.md +2 -2
- data/doc_out/EncryptionKeyEntityListing.html.md +2 -2
- data/doc_out/Endpoint.html.md +1 -1
- data/doc_out/EndpointEntityListing.html.md +2 -2
- data/doc_out/Evaluation.html.md +4 -4
- data/doc_out/EvaluationEntityListing.html.md +2 -2
- data/doc_out/EvaluationForm.html.md +1 -1
- data/doc_out/EvaluationFormEntityListing.html.md +2 -2
- data/doc_out/EvaluationScoringSet.html.md +1 -1
- data/doc_out/EvaluatorActivityEntityListing.html.md +2 -2
- data/doc_out/ExportUriNotification.html.md +15 -0
- data/doc_out/ExtensionEntityListing.html.md +2 -2
- data/doc_out/ExtensionPoolEntityListing.html.md +2 -2
- data/doc_out/FaxDocument.html.md +1 -1
- data/doc_out/FaxDocumentEntityListing.html.md +2 -2
- data/doc_out/FieldList.html.md +3 -3
- data/doc_out/Geolocation.html.md +1 -1
- data/doc_out/GeolocationSettings.html.md +1 -1
- data/doc_out/GreetingListing.html.md +2 -2
- data/doc_out/Group.html.md +1 -1
- data/doc_out/GroupEntityListing.html.md +2 -2
- data/doc_out/GroupUpdate.html.md +1 -1
- data/doc_out/HeartBeatAlertContainer.html.md +2 -2
- data/doc_out/HeartBeatRule.html.md +2 -2
- data/doc_out/HeartBeatRuleContainer.html.md +2 -2
- data/doc_out/ImportStatusNotification.html.md +18 -0
- data/doc_out/InboundDomain.html.md +1 -1
- data/doc_out/InboundDomainEntityListing.html.md +2 -2
- data/doc_out/InboundRouteEntityListing.html.md +2 -2
- data/doc_out/InitiateScreenRecording.html.md +1 -1
- data/doc_out/InteractionStatsAlert.html.md +1 -1
- data/doc_out/InteractionStatsAlertContainer.html.md +2 -2
- data/doc_out/InteractionStatsRule.html.md +2 -2
- data/doc_out/InteractionStatsRuleContainer.html.md +2 -2
- data/doc_out/JsonNode.html.md +20 -20
- data/doc_out/KeywordSetEntityListing.html.md +2 -2
- data/doc_out/LanguageEntityListing.html.md +2 -2
- 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/LineStatus.html.md +1 -1
- data/doc_out/LocalEncryptionConfigurationListing.html.md +2 -2
- data/doc_out/LocationDefinition.html.md +1 -1
- data/doc_out/LogicalInterfaceEntityListing.html.md +2 -2
- data/doc_out/MediaParticipantRequest.html.md +5 -5
- data/doc_out/MeteredEvaluationAssignment.html.md +1 -1
- data/doc_out/OAuthClientEntityListing.html.md +2 -2
- data/doc_out/OAuthProvider.html.md +1 -1
- data/doc_out/OAuthProviderEntityListing.html.md +2 -2
- data/doc_out/Okta.html.md +1 -1
- data/doc_out/OneLogin.html.md +1 -1
- data/doc_out/OrgMediaUtilization.html.md +1 -1
- data/doc_out/Organization.html.md +1 -1
- data/doc_out/OrganizationPresence.html.md +2 -2
- 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/OutOfOffice.html.md +1 -1
- data/doc_out/OutboundRoute.html.md +4 -4
- data/doc_out/OutboundRouteBase.html.md +28 -0
- data/doc_out/OutboundRouteBaseEntityListing.html.md +22 -0
- data/doc_out/OutboundRouteEntityListing.html.md +2 -2
- data/doc_out/Parameter.html.md +1 -1
- data/doc_out/Participant.html.md +2 -2
- data/doc_out/PermissionCollectionEntityListing.html.md +2 -2
- data/doc_out/PhoneBaseEntityListing.html.md +2 -2
- data/doc_out/PhoneCapabilities.html.md +5 -5
- data/doc_out/PhoneEntityListing.html.md +2 -2
- data/doc_out/PhoneMetaBaseEntityListing.html.md +2 -2
- data/doc_out/PhoneNumberStatus.html.md +1 -1
- data/doc_out/PhysicalInterfaceEntityListing.html.md +2 -2
- data/doc_out/Policy.html.md +1 -1
- data/doc_out/PolicyActions.html.md +3 -3
- data/doc_out/PolicyCreate.html.md +1 -1
- data/doc_out/PolicyEntityListing.html.md +2 -2
- data/doc_out/PureCloud.html.md +1 -1
- data/doc_out/QualityAuditPage.html.md +2 -2
- data/doc_out/QueryRequest.html.md +1 -1
- data/doc_out/QuestionGroup.html.md +4 -4
- data/doc_out/QuestionGroupScore.html.md +1 -1
- data/doc_out/QuestionScore.html.md +2 -2
- data/doc_out/QueueEntityListing.html.md +2 -2
- data/doc_out/QueueMember.html.md +1 -1
- data/doc_out/QueueMemberEntityListing.html.md +2 -2
- data/doc_out/ReportMetaDataEntityListing.html.md +2 -2
- data/doc_out/ReportRunEntryEntityDomainListing.html.md +2 -2
- data/doc_out/ReportSchedule.html.md +1 -1
- data/doc_out/ReportScheduleEntityListing.html.md +2 -2
- data/doc_out/ResourcePermissionPolicy.html.md +1 -1
- data/doc_out/ResponseEntityList.html.md +2 -2
- data/doc_out/ResponseEntityListing.html.md +2 -2
- data/doc_out/ResponseSetEntityListing.html.md +2 -2
- data/doc_out/ResponseSetNotification.html.md +19 -0
- data/doc_out/ResponseSetNotificationReaction.html.md +16 -0
- data/doc_out/ResponseSetNotificationResponses.html.md +16 -0
- data/doc_out/RoutingStatusAlertContainer.html.md +2 -2
- data/doc_out/RoutingStatusRule.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 +21 -0
- data/doc_out/RuleSetNotificationAction.html.md +17 -0
- data/doc_out/RuleSetNotificationActions.html.md +17 -0
- data/doc_out/RuleSetNotificationCondition.html.md +20 -0
- data/doc_out/RuleSetNotificationConditions.html.md +20 -0
- data/doc_out/RuleSetNotificationRule.html.md +19 -0
- data/doc_out/RuleSetNotificationRules.html.md +19 -0
- data/doc_out/RuleSetNotificationUriReference.html.md +14 -0
- data/doc_out/Salesforce.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/Screenshare.html.md +1 -1
- data/doc_out/ScriptEntityListing.html.md +2 -2
- data/doc_out/SecurityProfileEntityListing.html.md +2 -2
- data/doc_out/SequenceScheduleNotification.html.md +21 -0
- data/doc_out/SequenceScheduleNotificationScheduleInterval.html.md +15 -0
- data/doc_out/SequenceScheduleNotificationUriReference.html.md +14 -0
- data/doc_out/ShareEntityListing.html.md +2 -2
- data/doc_out/Site.html.md +1 -1
- data/doc_out/SiteEntityListing.html.md +2 -2
- data/doc_out/SkillEntityListing.html.md +2 -2
- data/doc_out/SocialExpression.html.md +1 -1
- data/doc_out/SortItem.html.md +1 -1
- data/doc_out/StationEntityListing.html.md +2 -2
- data/doc_out/StationsApi.html.md +2 -0
- data/doc_out/TagValue.html.md +1 -1
- data/doc_out/TagValueEntityListing.html.md +2 -2
- data/doc_out/TelephonyProvidersEdgeApi.html.md +311 -0
- data/doc_out/TimeAllowed.html.md +1 -1
- data/doc_out/TimeOffRequest.html.md +2 -2
- data/doc_out/TimeOffRequestPatch.html.md +1 -1
- data/doc_out/TimeZoneEntityListing.html.md +2 -2
- data/doc_out/TransferRequest.html.md +1 -1
- data/doc_out/Trunk.html.md +1 -1
- data/doc_out/TrunkBase.html.md +1 -1
- 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/UnreadStatus.html.md +1 -1
- data/doc_out/UserEntityListing.html.md +2 -2
- data/doc_out/UserPresence.html.md +1 -1
- data/doc_out/UserPresenceAlertContainer.html.md +2 -2
- data/doc_out/UserPresenceRule.html.md +2 -2
- data/doc_out/UserPresenceRuleContainer.html.md +2 -2
- data/doc_out/UserQueue.html.md +1 -1
- data/doc_out/UserQueueEntityListing.html.md +2 -2
- data/doc_out/UserRecording.html.md +1 -1
- data/doc_out/UserRecordingEntityListing.html.md +2 -2
- data/doc_out/UserScheduleAdherence.html.md +1 -1
- data/doc_out/UserSkillEntityListing.html.md +2 -2
- data/doc_out/UsersApi.html.md +2 -2
- data/doc_out/ValidateAddressResponse.html.md +1 -1
- data/doc_out/Video.html.md +3 -3
- data/doc_out/VoicemailApi.html.md +9 -3
- data/doc_out/VoicemailGroupPolicy.html.md +2 -2
- data/doc_out/VoicemailMessage.html.md +2 -2
- data/doc_out/VoicemailMessageEntityListing.html.md +2 -2
- data/doc_out/VoicemailOrganizationPolicy.html.md +4 -4
- data/doc_out/VoicemailUserPolicy.html.md +1 -1
- data/doc_out/WorkforceManagementApi.html.md +58 -0
- data/doc_out/Workspace.html.md +1 -1
- data/doc_out/WorkspaceEntityListing.html.md +2 -2
- data/doc_out/WorkspaceMemberEntityListing.html.md +2 -2
- data/doc_out/WrapUpCodeMappingNotification.html.md +21 -0
- data/doc_out/Wrapup.html.md +1 -1
- data/doc_out/WrapupCodeEntityListing.html.md +2 -2
- data/doc_out/index.html.md +3 -3
- data/lib/purecloud.rb +57 -1
- data/lib/purecloud/api/stations_api.rb +3 -0
- data/lib/purecloud/api/telephony_providers_edge_api.rb +334 -0
- data/lib/purecloud/api/users_api.rb +3 -3
- data/lib/purecloud/api/voicemail_api.rb +6 -0
- data/lib/purecloud/api/workforce_management_api.rb +57 -0
- data/lib/purecloud/api_client.rb +1 -1
- data/lib/purecloud/models/adfs.rb +0 -2
- data/lib/purecloud/models/agent_activity_entity_listing.rb +13 -13
- data/lib/purecloud/models/aggregate_metric_data.rb +1 -1
- data/lib/purecloud/models/aggregation_query.rb +0 -2
- data/lib/purecloud/models/analytics_conversation.rb +12 -1
- data/lib/purecloud/models/analytics_conversation_segment.rb +0 -6
- data/lib/purecloud/models/analytics_query_predicate.rb +1 -1
- data/lib/purecloud/models/analytics_session.rb +0 -4
- data/lib/purecloud/models/attempt_limits_entity_listing.rb +13 -13
- data/lib/purecloud/models/attempt_limits_notification.rb +276 -0
- data/lib/purecloud/models/attempt_limits_notification_recall_entries.rb +185 -0
- data/lib/purecloud/models/attempt_limits_notification_recall_entry.rb +185 -0
- data/lib/purecloud/models/attribute_entity_listing.rb +13 -13
- data/lib/purecloud/models/audit_message.rb +0 -2
- data/lib/purecloud/models/calibration_entity_listing.rb +13 -13
- data/lib/purecloud/models/call.rb +0 -8
- data/lib/purecloud/models/call_conversation_entity_listing.rb +13 -13
- data/lib/purecloud/models/call_forwarding.rb +0 -2
- data/lib/purecloud/models/call_media_participant.rb +0 -12
- data/lib/purecloud/models/callable_time_set_entity_listing.rb +13 -13
- data/lib/purecloud/models/callable_time_set_notification.rb +227 -0
- data/lib/purecloud/models/callable_time_set_notification_callable_time.rb +187 -0
- data/lib/purecloud/models/callable_time_set_notification_callable_times.rb +187 -0
- data/lib/purecloud/models/callable_time_set_notification_time_slot.rb +195 -0
- data/lib/purecloud/models/callable_time_set_notification_time_slots.rb +195 -0
- data/lib/purecloud/models/callback.rb +12 -5
- data/lib/purecloud/models/callback_conversation_entity_listing.rb +13 -13
- data/lib/purecloud/models/callback_conversation_notification_dialer_preview.rb +1 -1
- data/lib/purecloud/models/callback_media_participant.rb +12 -9
- data/lib/purecloud/models/campaign.rb +0 -2
- data/lib/purecloud/models/campaign_entity_listing.rb +13 -13
- data/lib/purecloud/models/campaign_interaction.rb +0 -2
- data/lib/purecloud/models/campaign_notification.rb +471 -0
- data/lib/purecloud/models/campaign_notification_contact_sort.rb +204 -0
- data/lib/purecloud/models/campaign_notification_error.rb +185 -0
- data/lib/purecloud/models/campaign_notification_errors.rb +185 -0
- data/lib/purecloud/models/campaign_notification_phone_column.rb +185 -0
- data/lib/purecloud/models/{conversation_notification_dialer_preview_phone_number_columns.rb → campaign_notification_phone_columns.rb} +1 -1
- data/lib/purecloud/models/campaign_notification_uri_reference.rb +175 -0
- data/lib/purecloud/models/campaign_progress_notification.rb +205 -0
- data/lib/purecloud/models/campaign_progress_notification_uri_reference.rb +175 -0
- data/lib/purecloud/models/campaign_rule.rb +0 -4
- data/lib/purecloud/models/campaign_rule_action_entities.rb +0 -2
- data/lib/purecloud/models/campaign_rule_entity_listing.rb +13 -13
- data/lib/purecloud/models/campaign_rule_notification.rb +269 -0
- data/lib/purecloud/models/campaign_rule_notification_campaign_rule_action.rb +216 -0
- data/lib/purecloud/models/campaign_rule_notification_campaign_rule_action_entities.rb +199 -0
- data/lib/purecloud/models/campaign_rule_notification_campaign_rule_actions.rb +216 -0
- data/lib/purecloud/models/campaign_rule_notification_campaign_rule_condition.rb +206 -0
- data/lib/purecloud/models/campaign_rule_notification_campaign_rule_conditions.rb +206 -0
- data/lib/purecloud/models/campaign_rule_notification_campaign_rule_entities.rb +189 -0
- data/lib/purecloud/models/campaign_schedule_notification.rb +247 -0
- data/lib/purecloud/models/campaign_schedule_notification_intervals.rb +185 -0
- data/lib/purecloud/models/campaign_schedule_notification_schedule_interval.rb +185 -0
- data/lib/purecloud/models/campaign_schedule_notification_uri_reference.rb +175 -0
- data/lib/purecloud/models/campaign_sequence.rb +0 -2
- data/lib/purecloud/models/campaign_sequence_entity_listing.rb +13 -13
- data/lib/purecloud/models/campaign_sequence_notification.rb +276 -0
- data/lib/purecloud/models/campaign_sequence_notification_uri_reference.rb +175 -0
- data/lib/purecloud/models/certificate_authority_entity_listing.rb +13 -13
- data/lib/purecloud/models/certificate_details.rb +0 -6
- data/lib/purecloud/models/channel_entity_listing.rb +13 -13
- data/lib/purecloud/models/chat_conversation_entity_listing.rb +13 -13
- data/lib/purecloud/models/chat_media_participant.rb +0 -6
- data/lib/purecloud/models/cobrowse_conversation_entity_listing.rb +13 -13
- data/lib/purecloud/models/cobrowse_media_participant.rb +0 -6
- data/lib/purecloud/models/command_status_entity_listing.rb +13 -13
- data/lib/purecloud/models/condition.rb +0 -2
- data/lib/purecloud/models/contact_list_entity_listing.rb +13 -13
- data/lib/purecloud/models/contact_list_notification.rb +291 -0
- data/lib/purecloud/models/contact_list_notification_import_status.rb +224 -0
- data/lib/purecloud/models/contact_list_notification_phone_column_.rb +195 -0
- data/lib/purecloud/models/contact_list_notification_phone_columns.rb +195 -0
- data/lib/purecloud/models/contact_list_notification_uri_reference.rb +175 -0
- data/lib/purecloud/models/contact_sort.rb +0 -2
- data/lib/purecloud/models/content_query_request.rb +0 -2
- data/lib/purecloud/models/content_sort_item.rb +0 -2
- data/lib/purecloud/models/conversation_chat.rb +0 -2
- data/lib/purecloud/models/conversation_entity_listing.rb +13 -13
- data/lib/purecloud/models/conversation_notification_dialer_preview.rb +1 -1
- data/lib/purecloud/models/conversation_query.rb +1 -1
- data/lib/purecloud/models/current_user_schedule_request_body.rb +178 -0
- data/lib/purecloud/models/customer_interaction_center.rb +0 -2
- data/lib/purecloud/models/decisions_file_metadata_entity_listing.rb +13 -13
- data/lib/purecloud/models/dialer_contact.rb +0 -2
- data/lib/purecloud/models/did_entity_listing.rb +13 -13
- data/lib/purecloud/models/did_pool_entity_listing.rb +13 -13
- data/lib/purecloud/models/dnc_list_entity_listing.rb +13 -13
- data/lib/purecloud/models/dnc_list_notification.rb +286 -0
- data/lib/purecloud/models/dnc_list_notification_import_status.rb +224 -0
- data/lib/purecloud/models/document.rb +0 -2
- data/lib/purecloud/models/document_audit.rb +0 -2
- data/lib/purecloud/models/document_audit_entity_listing.rb +13 -13
- data/lib/purecloud/models/document_entity_listing.rb +13 -13
- data/lib/purecloud/models/document_update.rb +0 -2
- data/lib/purecloud/models/domain_capabilities.rb +0 -8
- data/lib/purecloud/models/domain_edge_software_update_dto.rb +0 -4
- data/lib/purecloud/models/domain_edge_software_version_dto.rb +0 -4
- data/lib/purecloud/models/domain_edge_software_version_dto_entity_listing.rb +13 -13
- data/lib/purecloud/models/domain_entity_listing.rb +13 -13
- data/lib/purecloud/models/domain_entity_listing_evaluation_form.rb +13 -13
- data/lib/purecloud/models/domain_entity_listing_query_result.rb +13 -13
- data/lib/purecloud/models/domain_logical_interface.rb +0 -6
- data/lib/purecloud/models/domain_network_address.rb +0 -2
- data/lib/purecloud/models/domain_network_command_response.rb +0 -2
- data/lib/purecloud/models/domain_network_route.rb +0 -2
- data/lib/purecloud/models/domain_organization_role.rb +0 -6
- data/lib/purecloud/models/domain_organization_role_create.rb +0 -6
- data/lib/purecloud/models/domain_organization_role_update.rb +0 -6
- data/lib/purecloud/models/domain_permission.rb +0 -2
- data/lib/purecloud/models/domain_permission_policy.rb +0 -2
- data/lib/purecloud/models/domain_physical_capabilities.rb +0 -4
- data/lib/purecloud/models/edge.rb +0 -4
- data/lib/purecloud/models/edge_auto_update_config.rb +4 -4
- data/lib/purecloud/models/edge_entity_listing.rb +13 -13
- data/lib/purecloud/models/edge_group.rb +0 -2
- data/lib/purecloud/models/edge_group_entity_listing.rb +13 -13
- data/lib/purecloud/models/edge_line_entity_listing.rb +13 -13
- data/lib/purecloud/models/edge_logs_job_request.rb +0 -2
- data/lib/purecloud/models/email.rb +0 -2
- data/lib/purecloud/models/email_conversation_entity_listing.rb +13 -13
- data/lib/purecloud/models/email_media_participant.rb +0 -6
- data/lib/purecloud/models/email_message_listing.rb +13 -13
- data/lib/purecloud/models/encryption_key_entity_listing.rb +13 -13
- data/lib/purecloud/models/endpoint.rb +0 -2
- data/lib/purecloud/models/endpoint_entity_listing.rb +13 -13
- data/lib/purecloud/models/evaluation.rb +0 -8
- data/lib/purecloud/models/evaluation_entity_listing.rb +13 -13
- data/lib/purecloud/models/evaluation_form.rb +0 -2
- data/lib/purecloud/models/evaluation_form_entity_listing.rb +13 -13
- data/lib/purecloud/models/evaluation_scoring_set.rb +0 -2
- data/lib/purecloud/models/evaluator_activity_entity_listing.rb +13 -13
- data/lib/purecloud/models/export_uri_notification.rb +185 -0
- data/lib/purecloud/models/extension_entity_listing.rb +13 -13
- data/lib/purecloud/models/extension_pool_entity_listing.rb +13 -13
- data/lib/purecloud/models/fax_document.rb +0 -2
- data/lib/purecloud/models/fax_document_entity_listing.rb +13 -13
- data/lib/purecloud/models/field_list.rb +0 -6
- data/lib/purecloud/models/geolocation.rb +0 -2
- data/lib/purecloud/models/geolocation_settings.rb +0 -2
- data/lib/purecloud/models/greeting_listing.rb +13 -13
- data/lib/purecloud/models/group.rb +0 -2
- data/lib/purecloud/models/group_entity_listing.rb +13 -13
- data/lib/purecloud/models/group_update.rb +0 -2
- data/lib/purecloud/models/heart_beat_alert_container.rb +13 -13
- data/lib/purecloud/models/heart_beat_rule.rb +0 -4
- data/lib/purecloud/models/heart_beat_rule_container.rb +13 -13
- data/lib/purecloud/models/import_status_notification.rb +224 -0
- data/lib/purecloud/models/inbound_domain.rb +0 -2
- data/lib/purecloud/models/inbound_domain_entity_listing.rb +13 -13
- data/lib/purecloud/models/inbound_route_entity_listing.rb +13 -13
- data/lib/purecloud/models/initiate_screen_recording.rb +0 -2
- data/lib/purecloud/models/interaction_stats_alert.rb +0 -2
- data/lib/purecloud/models/interaction_stats_alert_container.rb +13 -13
- data/lib/purecloud/models/interaction_stats_rule.rb +0 -4
- data/lib/purecloud/models/interaction_stats_rule_container.rb +13 -13
- data/lib/purecloud/models/json_node.rb +0 -40
- data/lib/purecloud/models/keyword_set_entity_listing.rb +13 -13
- data/lib/purecloud/models/language_entity_listing.rb +13 -13
- data/lib/purecloud/models/library_entity_listing.rb +13 -13
- data/lib/purecloud/models/line_base_entity_listing.rb +13 -13
- data/lib/purecloud/models/line_entity_listing.rb +13 -13
- data/lib/purecloud/models/line_status.rb +0 -2
- data/lib/purecloud/models/local_encryption_configuration_listing.rb +13 -13
- data/lib/purecloud/models/location_definition.rb +0 -2
- data/lib/purecloud/models/logical_interface_entity_listing.rb +13 -13
- data/lib/purecloud/models/media_participant_request.rb +0 -10
- data/lib/purecloud/models/metered_evaluation_assignment.rb +0 -2
- data/lib/purecloud/models/o_auth_client_entity_listing.rb +13 -13
- data/lib/purecloud/models/o_auth_provider.rb +0 -2
- data/lib/purecloud/models/o_auth_provider_entity_listing.rb +13 -13
- data/lib/purecloud/models/okta.rb +0 -2
- data/lib/purecloud/models/one_login.rb +0 -2
- data/lib/purecloud/models/org_media_utilization.rb +0 -2
- data/lib/purecloud/models/organization.rb +0 -2
- data/lib/purecloud/models/organization_presence.rb +0 -4
- data/lib/purecloud/models/organization_presence_entity_listing.rb +13 -13
- data/lib/purecloud/models/organization_role_entity_listing.rb +13 -13
- data/lib/purecloud/models/orphan_recording_listing.rb +13 -13
- data/lib/purecloud/models/out_of_office.rb +0 -2
- data/lib/purecloud/models/outbound_route.rb +23 -25
- data/lib/purecloud/models/outbound_route_base.rb +344 -0
- data/lib/purecloud/models/outbound_route_base_entity_listing.rb +257 -0
- data/lib/purecloud/models/outbound_route_entity_listing.rb +13 -13
- data/lib/purecloud/models/parameter.rb +0 -2
- data/lib/purecloud/models/participant.rb +0 -4
- data/lib/purecloud/models/permission_collection_entity_listing.rb +13 -13
- data/lib/purecloud/models/phone_base_entity_listing.rb +13 -13
- data/lib/purecloud/models/phone_capabilities.rb +0 -10
- data/lib/purecloud/models/phone_entity_listing.rb +13 -13
- data/lib/purecloud/models/phone_meta_base_entity_listing.rb +13 -13
- data/lib/purecloud/models/phone_number_status.rb +0 -2
- data/lib/purecloud/models/physical_interface_entity_listing.rb +13 -13
- data/lib/purecloud/models/policy.rb +0 -2
- data/lib/purecloud/models/policy_actions.rb +0 -6
- data/lib/purecloud/models/policy_create.rb +0 -2
- data/lib/purecloud/models/policy_entity_listing.rb +13 -13
- data/lib/purecloud/models/pure_cloud.rb +0 -2
- data/lib/purecloud/models/quality_audit_page.rb +13 -13
- data/lib/purecloud/models/query_request.rb +0 -2
- data/lib/purecloud/models/question_group.rb +0 -8
- data/lib/purecloud/models/question_group_score.rb +0 -2
- data/lib/purecloud/models/question_score.rb +0 -4
- data/lib/purecloud/models/queue_entity_listing.rb +13 -13
- data/lib/purecloud/models/queue_member.rb +0 -2
- data/lib/purecloud/models/queue_member_entity_listing.rb +13 -13
- data/lib/purecloud/models/report_meta_data_entity_listing.rb +13 -13
- data/lib/purecloud/models/report_run_entry_entity_domain_listing.rb +13 -13
- data/lib/purecloud/models/report_schedule.rb +0 -2
- data/lib/purecloud/models/report_schedule_entity_listing.rb +13 -13
- data/lib/purecloud/models/resource_permission_policy.rb +0 -2
- data/lib/purecloud/models/response_entity_list.rb +13 -13
- data/lib/purecloud/models/response_entity_listing.rb +13 -13
- data/lib/purecloud/models/response_set_entity_listing.rb +13 -13
- data/lib/purecloud/models/response_set_notification.rb +227 -0
- data/lib/purecloud/models/response_set_notification_reaction.rb +204 -0
- data/lib/purecloud/models/response_set_notification_responses.rb +204 -0
- data/lib/purecloud/models/routing_status_alert_container.rb +13 -13
- data/lib/purecloud/models/routing_status_rule.rb +0 -4
- data/lib/purecloud/models/routing_status_rule_container.rb +13 -13
- data/lib/purecloud/models/rule_set_entity_listing.rb +13 -13
- data/lib/purecloud/models/rule_set_notification.rb +247 -0
- data/lib/purecloud/models/rule_set_notification_action.rb +207 -0
- data/lib/purecloud/models/rule_set_notification_actions.rb +207 -0
- data/lib/purecloud/models/rule_set_notification_condition.rb +255 -0
- data/lib/purecloud/models/rule_set_notification_conditions.rb +255 -0
- data/lib/purecloud/models/rule_set_notification_rule.rb +229 -0
- data/lib/purecloud/models/rule_set_notification_rules.rb +229 -0
- data/lib/purecloud/models/rule_set_notification_uri_reference.rb +175 -0
- data/lib/purecloud/models/salesforce.rb +0 -2
- data/lib/purecloud/models/schema_category_entity_listing.rb +13 -13
- data/lib/purecloud/models/schema_reference_entity_listing.rb +13 -13
- data/lib/purecloud/models/screen_recording_session_listing.rb +13 -13
- data/lib/purecloud/models/screenshare.rb +0 -2
- data/lib/purecloud/models/script_entity_listing.rb +13 -13
- data/lib/purecloud/models/security_profile_entity_listing.rb +13 -13
- data/lib/purecloud/models/sequence_schedule_notification.rb +247 -0
- data/lib/purecloud/models/sequence_schedule_notification_schedule_interval.rb +185 -0
- data/lib/purecloud/models/sequence_schedule_notification_uri_reference.rb +175 -0
- data/lib/purecloud/models/share_entity_listing.rb +13 -13
- data/lib/purecloud/models/site.rb +0 -2
- data/lib/purecloud/models/site_entity_listing.rb +13 -13
- data/lib/purecloud/models/skill_entity_listing.rb +13 -13
- data/lib/purecloud/models/social_expression.rb +0 -2
- data/lib/purecloud/models/sort_item.rb +0 -2
- data/lib/purecloud/models/station_entity_listing.rb +13 -13
- data/lib/purecloud/models/tag_value.rb +0 -2
- data/lib/purecloud/models/tag_value_entity_listing.rb +13 -13
- data/lib/purecloud/models/time_allowed.rb +0 -2
- data/lib/purecloud/models/time_off_request.rb +0 -4
- data/lib/purecloud/models/time_off_request_patch.rb +0 -2
- data/lib/purecloud/models/time_zone_entity_listing.rb +13 -13
- data/lib/purecloud/models/transfer_request.rb +0 -2
- data/lib/purecloud/models/trunk.rb +0 -2
- data/lib/purecloud/models/trunk_base.rb +0 -2
- data/lib/purecloud/models/trunk_base_entity_listing.rb +13 -13
- data/lib/purecloud/models/trunk_entity_listing.rb +13 -13
- data/lib/purecloud/models/trunk_metabase_entity_listing.rb +13 -13
- data/lib/purecloud/models/unread_status.rb +0 -2
- data/lib/purecloud/models/user_entity_listing.rb +13 -13
- data/lib/purecloud/models/user_presence.rb +0 -2
- data/lib/purecloud/models/user_presence_alert_container.rb +13 -13
- data/lib/purecloud/models/user_presence_rule.rb +0 -4
- data/lib/purecloud/models/user_presence_rule_container.rb +13 -13
- data/lib/purecloud/models/user_queue.rb +0 -2
- data/lib/purecloud/models/user_queue_entity_listing.rb +13 -13
- data/lib/purecloud/models/user_recording.rb +0 -2
- data/lib/purecloud/models/user_recording_entity_listing.rb +13 -13
- data/lib/purecloud/models/user_schedule_adherence.rb +0 -2
- data/lib/purecloud/models/user_skill_entity_listing.rb +13 -13
- data/lib/purecloud/models/validate_address_response.rb +0 -2
- data/lib/purecloud/models/video.rb +0 -6
- data/lib/purecloud/models/voicemail_group_policy.rb +0 -4
- data/lib/purecloud/models/voicemail_message.rb +0 -4
- data/lib/purecloud/models/voicemail_message_entity_listing.rb +13 -13
- data/lib/purecloud/models/voicemail_organization_policy.rb +0 -8
- data/lib/purecloud/models/voicemail_user_policy.rb +0 -2
- data/lib/purecloud/models/workspace.rb +0 -2
- data/lib/purecloud/models/workspace_entity_listing.rb +13 -13
- data/lib/purecloud/models/workspace_member_entity_listing.rb +13 -13
- data/lib/purecloud/models/wrap_up_code_mapping_notification.rb +258 -0
- data/lib/purecloud/models/wrapup.rb +0 -2
- data/lib/purecloud/models/wrapup_code_entity_listing.rb +13 -13
- data/lib/purecloud/version.rb +1 -1
- data/newVersion.md +1 -1
- data/swagger.json +1 -1
- data/version.json +1 -1
- metadata +116 -4
@@ -0,0 +1,16 @@
|
|
1
|
+
---
|
2
|
+
title: CallableTimeSetNotificationTimeSlots
|
3
|
+
---
|
4
|
+
## PureCloud::CallableTimeSetNotificationTimeSlots
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **start_time** | **String** | | [optional] |
|
11
|
+
| **additional_properties** | **Object** | | [optional] |
|
12
|
+
| **day** | **Integer** | | [optional] |
|
13
|
+
| **stop_time** | **String** | | [optional] |
|
14
|
+
{: class="table table-striped"}
|
15
|
+
|
16
|
+
|
data/doc_out/Callback.html.md
CHANGED
@@ -11,18 +11,19 @@ title: Callback
|
|
11
11
|
| **id** | **String** | A globally unique identifier for this communication. | [optional] |
|
12
12
|
| **segments** | [**Array<Segment>**](Segment.html) | The time line of the participant's callback, divided into activity segments. | [optional] |
|
13
13
|
| **direction** | **String** | The direction of the call | [optional] |
|
14
|
-
| **held** | **BOOLEAN** | True if this call is held and the person on this side hears silence. | [optional]
|
14
|
+
| **held** | **BOOLEAN** | True if this call is held and the person on this side hears silence. | [optional] |
|
15
15
|
| **disconnect_type** | **String** | System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. | [optional] |
|
16
16
|
| **start_hold_time** | **DateTime** | The timestamp the callback was placed on hold in the cloud clock if the callback is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
17
17
|
| **dialer_preview** | [**DialerPreview**](DialerPreview.html) | The preview data to be used when this callback is a Preview. | [optional] |
|
18
18
|
| **callback_numbers** | **Array<String>** | The phone number(s) to use to place the callback. | [optional] |
|
19
19
|
| **callback_user_name** | **String** | The name of the user requesting a callback. | [optional] |
|
20
20
|
| **script_id** | **String** | The UUID of the script to use. | [optional] |
|
21
|
-
| **skip_enabled** | **BOOLEAN** | True if the ability to skip a callback should be enabled. | [optional]
|
21
|
+
| **skip_enabled** | **BOOLEAN** | True if the ability to skip a callback should be enabled. | [optional] |
|
22
22
|
| **timeout_seconds** | **Integer** | The number of seconds before the system automatically places a call for a callback. 0 means the automatic placement is disabled. | [optional] |
|
23
23
|
| **connected_time** | **DateTime** | The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
24
24
|
| **disconnected_time** | **DateTime** | The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
25
25
|
| **callback_scheduled_time** | **DateTime** | The timestamp when this communication is scheduled in the provider clock. If this value is missing it indicates the callback will be placed immediately. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
26
|
+
| **automated_callback_config_id** | **String** | The id of the config for automatically placing the callback (and handling the disposition). If null, the callback will not be placed automatically but routed to an agent as per normal. | [optional] |
|
26
27
|
| **provider** | **String** | The source provider for the callback. | [optional] |
|
27
28
|
{: class="table table-striped"}
|
28
29
|
|
@@ -13,9 +13,9 @@ title: CallbackConversationEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
18
16
|
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,7 +11,7 @@ title: CallbackConversationNotificationDialerPreview
|
|
11
11
|
| **contact_id** | **String** | | [optional] |
|
12
12
|
| **contact_list_id** | **String** | | [optional] |
|
13
13
|
| **campaign_id** | **String** | | [optional] |
|
14
|
-
| **phone_number_columns** | [**Array<
|
14
|
+
| **phone_number_columns** | [**Array<CampaignNotificationPhoneColumns>**](CampaignNotificationPhoneColumns.html) | | [optional] |
|
15
15
|
| **additional_properties** | **Object** | | [optional] |
|
16
16
|
{: class="table table-striped"}
|
17
17
|
|
@@ -18,8 +18,8 @@ title: CallbackMediaParticipant
|
|
18
18
|
| **state** | **String** | The participant's state. Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting | [optional] |
|
19
19
|
| **direction** | **String** | The participant's direction. Values can be: 'inbound' or 'outbound' | [optional] |
|
20
20
|
| **disconnect_type** | **String** | The reason the participant was disconnected from the conversation. | [optional] |
|
21
|
-
| **held** | **BOOLEAN** | Value is true when the participant is on hold. | [optional]
|
22
|
-
| **wrapup_required** | **BOOLEAN** | Value is true when the participant requires wrap-up. | [optional]
|
21
|
+
| **held** | **BOOLEAN** | Value is true when the participant is on hold. | [optional] |
|
22
|
+
| **wrapup_required** | **BOOLEAN** | Value is true when the participant requires wrap-up. | [optional] |
|
23
23
|
| **wrapup_prompt** | **String** | The wrap-up prompt indicating the type of wrap-up to be performed. | [optional] |
|
24
24
|
| **user** | [**UriReference**](UriReference.html) | The PureCloud user for this participant. | [optional] |
|
25
25
|
| **queue** | [**UriReference**](UriReference.html) | The PureCloud queue for this participant. | [optional] |
|
@@ -27,15 +27,16 @@ title: CallbackMediaParticipant
|
|
27
27
|
| **error_info** | [**ErrorBody**](ErrorBody.html) | If the conversation ends in error, contains additional error details. | [optional] |
|
28
28
|
| **script** | [**UriReference**](UriReference.html) | The Engage script that should be used by this participant. | [optional] |
|
29
29
|
| **wrapup_timeout_ms** | **Integer** | The amount of time the participant has to complete wrap-up. | [optional] |
|
30
|
-
| **wrapup_skipped** | **BOOLEAN** | Value is true when the participant has skipped wrap-up. | [optional]
|
30
|
+
| **wrapup_skipped** | **BOOLEAN** | Value is true when the participant has skipped wrap-up. | [optional] |
|
31
31
|
| **provider** | **String** | The source provider for the communication. | [optional] |
|
32
32
|
| **external_contact** | [**UriReference**](UriReference.html) | If this participant represents an external contact, then this will be the reference for the external contact. | [optional] |
|
33
33
|
| **external_organization** | [**UriReference**](UriReference.html) | If this participant represents an external org, then this will be the reference for the external org. | [optional] |
|
34
34
|
| **outbound_preview** | [**DialerPreview**](DialerPreview.html) | The outbound preview associated with this callback. | [optional] |
|
35
35
|
| **callback_numbers** | **Array<String>** | The list of phone number to use for this callback. | [optional] |
|
36
36
|
| **callback_user_name** | **String** | The name of the callback target. | [optional] |
|
37
|
-
| **skip_enabled** | **BOOLEAN** | If true, the callback can be skipped | [optional]
|
37
|
+
| **skip_enabled** | **BOOLEAN** | If true, the callback can be skipped | [optional] |
|
38
38
|
| **timeout_seconds** | **Integer** | Duration in seconds before the callback will be auto-dialed. | [optional] |
|
39
|
+
| **automated_callback_config_id** | **String** | The id of the config for automatically placing the callback (and handling the disposition). If absent, the callback will not be placed automatically but routed to an agent as per normal. | [optional] |
|
39
40
|
| **callback_scheduled_time** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
40
41
|
{: class="table table-striped"}
|
41
42
|
|
data/doc_out/Campaign.html.md
CHANGED
@@ -28,7 +28,7 @@ title: Campaign
|
|
28
28
|
| **caller_address** | **String** | caller id phone number to be displayed on the outbound call | [optional] |
|
29
29
|
| **outbound_line_count** | **Integer** | for agentless campaigns, the number of outbound lines to be concurrently dialed | [optional] |
|
30
30
|
| **rule_sets** | [**Array<UriReference>**](UriReference.html) | identifiers of the rule sets | [optional] |
|
31
|
-
| **skip_preview_disabled** | **BOOLEAN** | for preview campaigns, indicator of whether the agent can skip a preview without placing a call | [optional]
|
31
|
+
| **skip_preview_disabled** | **BOOLEAN** | for preview campaigns, indicator of whether the agent can skip a preview without placing a call | [optional] |
|
32
32
|
| **preview_time_out_seconds** | **Integer** | for preview campaigns, number of seconds before a call will be automatically placed. A value of 0 indicates no automatic placement of calls | [optional] |
|
33
33
|
| **contact_sort** | [**ContactSort**](ContactSort.html) | information determining the order in which the contacts will be dialed | [optional] |
|
34
34
|
| **no_answer_timeout** | **Integer** | for non-preview campaigns, how long to wait before dispositioning as 'no-answer', default 30 seconds | [optional] |
|
@@ -13,9 +13,9 @@ title: CampaignEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
18
16
|
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -12,7 +12,7 @@ title: CampaignInteraction
|
|
12
12
|
| **agent** | [**UriReference**](UriReference.html) | | [optional] |
|
13
13
|
| **contact** | [**UriReference**](UriReference.html) | | [optional] |
|
14
14
|
| **destination_address** | **String** | | [optional] |
|
15
|
-
| **active_preview_call** | **BOOLEAN** | Boolean value if there is an active preview call on the interaction | [optional]
|
15
|
+
| **active_preview_call** | **BOOLEAN** | Boolean value if there is an active preview call on the interaction | [optional] |
|
16
16
|
| **last_active_preview_wrapup_time** | **DateTime** | The time when the last preview of the interaction was wrapped up. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
17
17
|
| **creation_time** | **DateTime** | The time when dialer created the interaction. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
18
18
|
| **call_placed_time** | **DateTime** | The time when the agent or system places the call. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
@@ -0,0 +1,41 @@
|
|
1
|
+
---
|
2
|
+
title: CampaignNotification
|
3
|
+
---
|
4
|
+
## PureCloud::CampaignNotification
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **id** | **String** | | [optional] |
|
11
|
+
| **name** | **String** | | [optional] |
|
12
|
+
| **date_created** | **DateTime** | | [optional] |
|
13
|
+
| **date_modified** | **DateTime** | | [optional] |
|
14
|
+
| **version** | **Integer** | | [optional] |
|
15
|
+
| **additional_properties** | **Object** | | [optional] |
|
16
|
+
| **contact_list** | [**DocumentDataNotificationCreatedBy**](DocumentDataNotificationCreatedBy.html) | | [optional] |
|
17
|
+
| **queue** | [**CampaignNotificationUriReference**](CampaignNotificationUriReference.html) | | [optional] |
|
18
|
+
| **dialing_mode** | **String** | | [optional] |
|
19
|
+
| **script** | [**CampaignNotificationUriReference**](CampaignNotificationUriReference.html) | | [optional] |
|
20
|
+
| **edge_group** | [**CampaignNotificationUriReference**](CampaignNotificationUriReference.html) | | [optional] |
|
21
|
+
| **campaign_status** | **String** | | [optional] |
|
22
|
+
| **phone_columns** | [**Array<CampaignNotificationPhoneColumns>**](CampaignNotificationPhoneColumns.html) | | [optional] |
|
23
|
+
| **abandon_rate** | **Float** | | [optional] |
|
24
|
+
| **dnc_lists** | [**Array<CampaignNotificationUriReference>**](CampaignNotificationUriReference.html) | | [optional] |
|
25
|
+
| **callable_time_set** | [**CampaignNotificationUriReference**](CampaignNotificationUriReference.html) | | [optional] |
|
26
|
+
| **call_analysis_response_set** | [**CampaignNotificationUriReference**](CampaignNotificationUriReference.html) | | [optional] |
|
27
|
+
| **caller_name** | **String** | | [optional] |
|
28
|
+
| **caller_address** | **String** | | [optional] |
|
29
|
+
| **outbound_line_count** | **Integer** | | [optional] |
|
30
|
+
| **errors** | [**Array<CampaignNotificationErrors>**](CampaignNotificationErrors.html) | | [optional] |
|
31
|
+
| **rule_sets** | [**Array<CampaignNotificationUriReference>**](CampaignNotificationUriReference.html) | | [optional] |
|
32
|
+
| **skip_preview_disabled** | **BOOLEAN** | | [optional] |
|
33
|
+
| **preview_time_out_seconds** | **Integer** | | [optional] |
|
34
|
+
| **single_number_preview** | **BOOLEAN** | | [optional] |
|
35
|
+
| **contact_sort** | [**CampaignNotificationContactSort**](CampaignNotificationContactSort.html) | | [optional] |
|
36
|
+
| **no_answer_timeout** | **Integer** | | [optional] |
|
37
|
+
| **call_analysis_language** | **String** | | [optional] |
|
38
|
+
| **priority** | **Integer** | | [optional] |
|
39
|
+
{: class="table table-striped"}
|
40
|
+
|
41
|
+
|
@@ -0,0 +1,16 @@
|
|
1
|
+
---
|
2
|
+
title: CampaignNotificationContactSort
|
3
|
+
---
|
4
|
+
## PureCloud::CampaignNotificationContactSort
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **numeric** | **BOOLEAN** | | [optional] |
|
11
|
+
| **additional_properties** | **Object** | | [optional] |
|
12
|
+
| **direction** | **String** | | [optional] |
|
13
|
+
| **field_name** | **String** | | [optional] |
|
14
|
+
{: class="table table-striped"}
|
15
|
+
|
16
|
+
|
@@ -0,0 +1,15 @@
|
|
1
|
+
---
|
2
|
+
title: CampaignNotificationError
|
3
|
+
---
|
4
|
+
## PureCloud::CampaignNotificationError
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **error** | **String** | | [optional] |
|
11
|
+
| **details** | **String** | | [optional] |
|
12
|
+
| **additional_properties** | **Object** | | [optional] |
|
13
|
+
{: class="table table-striped"}
|
14
|
+
|
15
|
+
|
@@ -0,0 +1,15 @@
|
|
1
|
+
---
|
2
|
+
title: CampaignNotificationErrors
|
3
|
+
---
|
4
|
+
## PureCloud::CampaignNotificationErrors
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **details** | **String** | | [optional] |
|
11
|
+
| **error** | **String** | | [optional] |
|
12
|
+
| **additional_properties** | **Object** | | [optional] |
|
13
|
+
{: class="table table-striped"}
|
14
|
+
|
15
|
+
|
@@ -1,15 +1,15 @@
|
|
1
1
|
---
|
2
|
-
title:
|
2
|
+
title: CampaignNotificationPhoneColumn
|
3
3
|
---
|
4
|
-
## PureCloud::
|
4
|
+
## PureCloud::CampaignNotificationPhoneColumn
|
5
5
|
|
6
6
|
## Properties
|
7
7
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **additional_properties** | **Object** | | [optional] |
|
11
10
|
| **column_name** | **String** | | [optional] |
|
12
11
|
| **type** | **String** | | [optional] |
|
12
|
+
| **additional_properties** | **Object** | | [optional] |
|
13
13
|
{: class="table table-striped"}
|
14
14
|
|
15
15
|
|
@@ -0,0 +1,15 @@
|
|
1
|
+
---
|
2
|
+
title: CampaignNotificationPhoneColumns
|
3
|
+
---
|
4
|
+
## PureCloud::CampaignNotificationPhoneColumns
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **additional_properties** | **Object** | | [optional] |
|
11
|
+
| **column_name** | **String** | | [optional] |
|
12
|
+
| **type** | **String** | | [optional] |
|
13
|
+
{: class="table table-striped"}
|
14
|
+
|
15
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
---
|
2
|
+
title: CampaignNotificationUriReference
|
3
|
+
---
|
4
|
+
## PureCloud::CampaignNotificationUriReference
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **id** | **String** | | [optional] |
|
11
|
+
| **name** | **String** | | [optional] |
|
12
|
+
{: class="table table-striped"}
|
13
|
+
|
14
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
---
|
2
|
+
title: CampaignProgressNotification
|
3
|
+
---
|
4
|
+
## PureCloud::CampaignProgressNotification
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **campaign** | [**DocumentDataNotificationCreatedBy**](DocumentDataNotificationCreatedBy.html) | | [optional] |
|
11
|
+
| **number_of_contacts_called** | **Float** | | [optional] |
|
12
|
+
| **total_number_of_contacts** | **Float** | | [optional] |
|
13
|
+
| **percentage** | **Integer** | | [optional] |
|
14
|
+
| **additional_properties** | **Object** | | [optional] |
|
15
|
+
{: class="table table-striped"}
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
---
|
2
|
+
title: CampaignProgressNotificationUriReference
|
3
|
+
---
|
4
|
+
## PureCloud::CampaignProgressNotificationUriReference
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **id** | **String** | | [optional] |
|
11
|
+
| **name** | **String** | | [optional] |
|
12
|
+
{: class="table table-striped"}
|
13
|
+
|
14
|
+
|
@@ -15,8 +15,8 @@ title: CampaignRule
|
|
15
15
|
| **campaign_rule_entities** | [**CampaignRuleEntities**](CampaignRuleEntities.html) | the list of entities the rule monitors | |
|
16
16
|
| **campaign_rule_conditions** | [**Array<CampaignRuleCondition>**](CampaignRuleCondition.html) | the list of conditions the are evaluated | |
|
17
17
|
| **campaign_rule_actions** | [**Array<CampaignRuleAction>**](CampaignRuleAction.html) | the list of actions that are executed if the conditions are satisfied | |
|
18
|
-
| **match_any_conditions** | **BOOLEAN** | | [optional]
|
19
|
-
| **enabled** | **BOOLEAN** | | [optional]
|
18
|
+
| **match_any_conditions** | **BOOLEAN** | | [optional] |
|
19
|
+
| **enabled** | **BOOLEAN** | | [optional] |
|
20
20
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
21
21
|
{: class="table table-striped"}
|
22
22
|
|
@@ -9,7 +9,7 @@ title: CampaignRuleActionEntities
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
10
|
| **campaigns** | [**Array<UriReference>**](UriReference.html) | | [optional] |
|
11
11
|
| **sequences** | [**Array<UriReference>**](UriReference.html) | | [optional] |
|
12
|
-
| **use_triggering_entity** | **BOOLEAN** | | [optional]
|
12
|
+
| **use_triggering_entity** | **BOOLEAN** | | [optional] |
|
13
13
|
{: class="table table-striped"}
|
14
14
|
|
15
15
|
|
@@ -13,9 +13,9 @@ title: CampaignRuleEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **previous_uri** | **String** | | [optional] |
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
18
16
|
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -0,0 +1,23 @@
|
|
1
|
+
---
|
2
|
+
title: CampaignRuleNotification
|
3
|
+
---
|
4
|
+
## PureCloud::CampaignRuleNotification
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **id** | **String** | | [optional] |
|
11
|
+
| **name** | **String** | | [optional] |
|
12
|
+
| **date_created** | **DateTime** | | [optional] |
|
13
|
+
| **date_modified** | **DateTime** | | [optional] |
|
14
|
+
| **version** | **Integer** | | [optional] |
|
15
|
+
| **additional_properties** | **Object** | | [optional] |
|
16
|
+
| **campaign_rule_entities** | [**CampaignRuleNotificationCampaignRuleEntities**](CampaignRuleNotificationCampaignRuleEntities.html) | | [optional] |
|
17
|
+
| **campaign_rule_conditions** | [**Array<CampaignRuleNotificationCampaignRuleConditions>**](CampaignRuleNotificationCampaignRuleConditions.html) | | [optional] |
|
18
|
+
| **campaign_rule_actions** | [**Array<CampaignRuleNotificationCampaignRuleActions>**](CampaignRuleNotificationCampaignRuleActions.html) | | [optional] |
|
19
|
+
| **match_any_conditions** | **BOOLEAN** | | [optional] |
|
20
|
+
| **enabled** | **BOOLEAN** | | [optional] |
|
21
|
+
{: class="table table-striped"}
|
22
|
+
|
23
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
---
|
2
|
+
title: CampaignRuleNotificationCampaignRuleAction
|
3
|
+
---
|
4
|
+
## PureCloud::CampaignRuleNotificationCampaignRuleAction
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **id** | **String** | | [optional] |
|
11
|
+
| **parameters** | **Hash<String, String>** | | [optional] |
|
12
|
+
| **action_type** | **String** | | [optional] |
|
13
|
+
| **campaign_rule_action_entities** | [**CampaignRuleNotificationCampaignRuleActionEntities**](CampaignRuleNotificationCampaignRuleActionEntities.html) | | [optional] |
|
14
|
+
| **additional_properties** | **Object** | | [optional] |
|
15
|
+
{: class="table table-striped"}
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,16 @@
|
|
1
|
+
---
|
2
|
+
title: CampaignRuleNotificationCampaignRuleActionEntities
|
3
|
+
---
|
4
|
+
## PureCloud::CampaignRuleNotificationCampaignRuleActionEntities
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **additional_properties** | **Object** | | [optional] |
|
11
|
+
| **sequences** | **Array<String>** | | [optional] |
|
12
|
+
| **campaigns** | **Array<String>** | | [optional] |
|
13
|
+
| **use_triggering_entity** | **BOOLEAN** | | [optional] |
|
14
|
+
{: class="table table-striped"}
|
15
|
+
|
16
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
---
|
2
|
+
title: CampaignRuleNotificationCampaignRuleActions
|
3
|
+
---
|
4
|
+
## PureCloud::CampaignRuleNotificationCampaignRuleActions
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **id** | **String** | | [optional] |
|
11
|
+
| **additional_properties** | **Object** | | [optional] |
|
12
|
+
| **action_type** | **String** | | [optional] |
|
13
|
+
| **parameters** | **Hash<String, String>** | | [optional] |
|
14
|
+
| **campaign_rule_action_entities** | [**CampaignRuleNotificationCampaignRuleActionEntities**](CampaignRuleNotificationCampaignRuleActionEntities.html) | | [optional] |
|
15
|
+
{: class="table table-striped"}
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,16 @@
|
|
1
|
+
---
|
2
|
+
title: CampaignRuleNotificationCampaignRuleCondition
|
3
|
+
---
|
4
|
+
## PureCloud::CampaignRuleNotificationCampaignRuleCondition
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **id** | **String** | | [optional] |
|
11
|
+
| **parameters** | **Hash<String, String>** | | [optional] |
|
12
|
+
| **condition_type** | **String** | | [optional] |
|
13
|
+
| **additional_properties** | **Object** | | [optional] |
|
14
|
+
{: class="table table-striped"}
|
15
|
+
|
16
|
+
|