purecloud 0.68.1 → 0.69.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 +12 -4
- data/config-ruby.json +1 -1
- data/doc_out/AgentActivityEntityListing.html.md +3 -3
- data/doc_out/AggregateViewData.html.md +14 -0
- data/doc_out/AggregationQuery.html.md +1 -0
- data/doc_out/AnalyticsView.html.md +16 -0
- data/doc_out/AnswerOption.html.md +15 -0
- data/doc_out/AttemptLimitsEntityListing.html.md +3 -3
- data/doc_out/AttemptLimitsNotificationRecallEntries.html.md +2 -2
- data/doc_out/AttributeEntityListing.html.md +3 -3
- data/doc_out/AvailableTopic.html.md +2 -2
- data/doc_out/CalibrationEntityListing.html.md +3 -3
- data/doc_out/CallBasic.html.md +31 -0
- data/doc_out/CallConversationEntityListing.html.md +3 -3
- data/doc_out/CallConversationNotificationCallMediaParticipant.html.md +1 -0
- data/doc_out/CallConversationNotificationErrorInfo.html.md +7 -7
- data/doc_out/CallConversationNotificationFaxStatus.html.md +5 -5
- data/doc_out/CallConversationNotificationParticipants.html.md +25 -24
- data/doc_out/CallConversationNotificationWrapup.html.md +18 -0
- data/doc_out/CallMediaParticipant.html.md +1 -0
- data/doc_out/CallableTimeSetEntityListing.html.md +3 -3
- data/doc_out/CallableTimeSetNotificationCallableTimes.html.md +1 -1
- data/doc_out/CallableTimeSetNotificationTimeSlots.html.md +1 -1
- data/doc_out/CallbackBasic.html.md +30 -0
- data/doc_out/CallbackConversationEntityListing.html.md +3 -3
- data/doc_out/CallbackConversationNotificationCallbackMediaParticipant.html.md +1 -0
- data/doc_out/CallbackConversationNotificationErrorInfo.html.md +7 -7
- data/doc_out/CallbackConversationNotificationErrorInfoDetails.html.md +2 -2
- data/doc_out/CallbackConversationNotificationParticipants.html.md +24 -23
- data/doc_out/CallbackConversationNotificationWrapup.html.md +18 -0
- data/doc_out/CallbackMediaParticipant.html.md +1 -0
- data/doc_out/CampaignEntityListing.html.md +3 -3
- data/doc_out/CampaignInteraction.html.md +1 -1
- data/doc_out/CampaignNotificationContactSort.html.md +1 -1
- data/doc_out/CampaignNotificationErrors.html.md +1 -1
- data/doc_out/CampaignNotificationPhoneColumns.html.md +1 -1
- data/doc_out/CampaignRuleEntityListing.html.md +3 -3
- data/doc_out/CampaignRuleNotificationCampaignRuleActionEntities.html.md +2 -2
- data/doc_out/CampaignRuleNotificationCampaignRuleActions.html.md +1 -1
- data/doc_out/CampaignRuleNotificationCampaignRuleConditions.html.md +1 -1
- data/doc_out/CampaignRuleNotificationCampaignRuleEntities.html.md +1 -1
- data/doc_out/CampaignScheduleNotificationIntervals.html.md +1 -1
- data/doc_out/CampaignSequenceEntityListing.html.md +3 -3
- data/doc_out/CampaignStats.html.md +2 -0
- data/doc_out/CertificateAuthorityEntityListing.html.md +3 -3
- data/doc_out/Channel.html.md +1 -1
- data/doc_out/ChannelEntityListing.html.md +0 -9
- data/doc_out/ChannelTopic.html.md +1 -1
- data/doc_out/ChatConversationEntityListing.html.md +3 -3
- data/doc_out/ChatConversationNotificationChatMediaParticipant.html.md +1 -0
- data/doc_out/ChatConversationNotificationErrorInfo.html.md +7 -7
- data/doc_out/ChatConversationNotificationParticipants.html.md +17 -16
- data/doc_out/ChatConversationNotificationWrapup.html.md +18 -0
- data/doc_out/ChatMediaParticipant.html.md +1 -0
- data/doc_out/CobrowseConversationEntityListing.html.md +3 -3
- data/doc_out/CobrowseConversationNotificationCobrowseMediaParticipant.html.md +1 -0
- data/doc_out/CobrowseConversationNotificationErrorInfo.html.md +7 -7
- data/doc_out/CobrowseConversationNotificationParticipants.html.md +22 -21
- data/doc_out/CobrowseConversationNotificationWrapup.html.md +18 -0
- data/doc_out/CobrowseMediaParticipant.html.md +1 -0
- data/doc_out/CommandStatusEntityListing.html.md +3 -3
- data/doc_out/ContactList.html.md +1 -0
- data/doc_out/ContactListEntityListing.html.md +3 -3
- data/doc_out/ContactListNotificationImportStatus.html.md +3 -3
- data/doc_out/ContactListNotificationPhoneColumns.html.md +1 -1
- data/doc_out/ConversationBasic.html.md +18 -0
- data/doc_out/ConversationEntityListing.html.md +3 -3
- data/doc_out/ConversationNotificationCallbacks.html.md +11 -11
- data/doc_out/ConversationNotificationCalls.html.md +12 -12
- data/doc_out/ConversationNotificationChats.html.md +5 -5
- data/doc_out/ConversationNotificationCobrowsesessions.html.md +8 -8
- data/doc_out/ConversationNotificationDialerPreview.html.md +3 -3
- data/doc_out/ConversationNotificationDisconnectReasons.html.md +1 -1
- data/doc_out/ConversationNotificationEmails.html.md +7 -7
- data/doc_out/ConversationNotificationErrorInfo.html.md +4 -4
- data/doc_out/ConversationNotificationFaxStatus.html.md +5 -5
- data/doc_out/ConversationNotificationParticipants.html.md +20 -20
- data/doc_out/ConversationNotificationScreenshares.html.md +7 -7
- data/doc_out/ConversationNotificationSelf.html.md +3 -3
- data/doc_out/ConversationNotificationSocialExpressions.html.md +5 -5
- data/doc_out/ConversationNotificationVideos.html.md +7 -7
- data/doc_out/ConversationNotificationWrapup.html.md +4 -4
- data/doc_out/CreateEmailRequest.html.md +1 -0
- data/doc_out/DIDEntityListing.html.md +3 -3
- data/doc_out/DIDPoolEntityListing.html.md +3 -3
- data/doc_out/DncListCreate.html.md +24 -0
- data/doc_out/DncListEntityListing.html.md +3 -3
- data/doc_out/DocumentAuditEntityListing.html.md +3 -3
- data/doc_out/DocumentDataV2NotificationCreatedBy.html.md +1 -1
- data/doc_out/DocumentDataV2NotificationLockInfo.html.md +1 -1
- data/doc_out/DocumentEntityListing.html.md +3 -3
- data/doc_out/DocumentationResult.html.md +32 -0
- data/doc_out/{ForecastSearchCriteria.html.md → DocumentationSearchCriteria.html.md} +3 -3
- data/doc_out/{ForecastSearchRequest.html.md → DocumentationSearchRequest.html.md} +3 -6
- data/doc_out/DocumentationSearchResponse.html.md +21 -0
- data/doc_out/DomainEdgeSoftwareUpdateDto.html.md +1 -0
- data/doc_out/DomainEdgeSoftwareVersionDtoEntityListing.html.md +3 -3
- data/doc_out/DomainEntityListing.html.md +3 -3
- data/doc_out/DomainEntityListingEvaluationForm.html.md +3 -3
- data/doc_out/DomainEntityListingQueryResult.html.md +3 -3
- 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 +3 -3
- data/doc_out/EdgeGroup.html.md +1 -1
- data/doc_out/EdgeGroupEntityListing.html.md +3 -3
- data/doc_out/EdgeLineEntityListing.html.md +3 -3
- data/doc_out/EdgeServiceStateRequest.html.md +14 -0
- data/doc_out/EdgeTrunkBase.html.md +27 -0
- data/doc_out/EmailConversationEntityListing.html.md +3 -3
- data/doc_out/EmailConversationNotificationEmailMediaParticipant.html.md +1 -0
- data/doc_out/EmailConversationNotificationErrorInfo.html.md +7 -7
- data/doc_out/EmailConversationNotificationParticipants.html.md +19 -18
- data/doc_out/EmailConversationNotificationWrapup.html.md +18 -0
- data/doc_out/EmailMediaParticipant.html.md +1 -0
- data/doc_out/EmailMessageListing.html.md +3 -3
- data/doc_out/EncryptionKeyEntityListing.html.md +3 -3
- data/doc_out/EndpointEntityListing.html.md +3 -3
- data/doc_out/Entry.html.md +2 -2
- data/doc_out/EvaluationEntityListing.html.md +3 -3
- data/doc_out/EvaluationFormEntityListing.html.md +3 -3
- data/doc_out/EvaluatorActivityEntityListing.html.md +3 -3
- data/doc_out/ExtensionEntityListing.html.md +3 -3
- data/doc_out/ExtensionPoolEntityListing.html.md +3 -3
- data/doc_out/FaxDataV2NotificationLockInfo.html.md +1 -1
- data/doc_out/FaxDocumentEntityListing.html.md +3 -3
- data/doc_out/{EntryFeatureBoolean.html.md → FeatureState.html.md} +3 -4
- data/doc_out/GSuite.html.md +20 -0
- data/doc_out/Geolocation.html.md +1 -0
- data/doc_out/GreetingListing.html.md +3 -3
- data/doc_out/GreetingsApi.html.md +3 -4
- data/doc_out/GroupEntityListing.html.md +3 -3
- data/doc_out/GroupSearchRequest.html.md +0 -2
- data/doc_out/GroupsApi.html.md +3 -4
- data/doc_out/HeartBeatAlertContainer.html.md +3 -3
- data/doc_out/HeartBeatAlertNotificationNotificationUsers.html.md +1 -1
- data/doc_out/HeartBeatRuleContainer.html.md +3 -3
- data/doc_out/IdentityProviderApi.html.md +247 -65
- data/doc_out/InboundDomainEntityListing.html.md +3 -3
- data/doc_out/InboundRouteEntityListing.html.md +3 -3
- data/doc_out/InteractionStatsAlertContainer.html.md +3 -3
- data/doc_out/InteractionStatsRuleContainer.html.md +3 -3
- data/doc_out/JsonNode.html.md +3 -3
- data/doc_out/KeywordSet.html.md +0 -1
- data/doc_out/KeywordSetEntityListing.html.md +3 -3
- data/doc_out/LanguageEntityListing.html.md +3 -3
- data/doc_out/LibraryEntityListing.html.md +3 -3
- data/doc_out/LineBaseEntityListing.html.md +3 -3
- data/doc_out/LineEntityListing.html.md +3 -3
- data/doc_out/LocalEncryptionConfigurationListing.html.md +1 -8
- data/doc_out/LocationSearchRequest.html.md +0 -2
- data/doc_out/LogicalInterfaceEntityListing.html.md +3 -3
- data/doc_out/NotificationsApi.html.md +7 -8
- data/doc_out/OAuthApi.html.md +4 -3
- data/doc_out/OAuthClientEntityListing.html.md +3 -3
- data/doc_out/OAuthProviderEntityListing.html.md +3 -3
- data/doc_out/OrganizationApi.html.md +13 -11
- data/doc_out/OrganizationFeatures.html.md +25 -0
- data/doc_out/OrganizationPresenceEntityListing.html.md +3 -3
- data/doc_out/OrganizationRoleEntityListing.html.md +3 -3
- data/doc_out/OrphanRecordingListing.html.md +3 -3
- data/doc_out/OutboundApi.html.md +8 -8
- data/doc_out/OutboundRouteBaseEntityListing.html.md +3 -3
- data/doc_out/OutboundRouteEntityListing.html.md +3 -3
- data/doc_out/ParticipantBasic.html.md +48 -0
- data/doc_out/PermissionCollectionEntityListing.html.md +3 -3
- data/doc_out/PhoneBaseEntityListing.html.md +3 -3
- data/doc_out/PhoneEntityListing.html.md +3 -3
- data/doc_out/PhoneMetaBaseEntityListing.html.md +3 -3
- data/doc_out/PhysicalInterfaceEntityListing.html.md +3 -3
- data/doc_out/PingIdentity.html.md +20 -0
- data/doc_out/PolicyEntityListing.html.md +3 -3
- data/doc_out/PredictionResults.html.md +1 -0
- data/doc_out/QualityAudit.html.md +1 -1
- data/doc_out/QualityAuditPage.html.md +3 -3
- data/doc_out/Question.html.md +24 -0
- data/doc_out/QuestionGroup.html.md +1 -1
- data/doc_out/QueueEntityListing.html.md +3 -3
- data/doc_out/QueueMember.html.md +1 -1
- data/doc_out/QueueMemberEntityListing.html.md +3 -3
- data/doc_out/RecordingDataV2NotificationLockInfo.html.md +1 -1
- data/doc_out/ReportMetaDataEntityListing.html.md +3 -3
- data/doc_out/ReportRunEntryEntityDomainListing.html.md +3 -3
- data/doc_out/ReportScheduleEntityListing.html.md +3 -3
- data/doc_out/Response.html.md +1 -0
- data/doc_out/ResponseEntityList.html.md +3 -3
- data/doc_out/ResponseEntityListing.html.md +3 -3
- data/doc_out/ResponseSetEntityListing.html.md +3 -3
- data/doc_out/ResponseSetNotificationResponses.html.md +2 -2
- data/doc_out/ResponseSubstitution.html.md +15 -0
- data/doc_out/RoutingApi.html.md +23 -290
- data/doc_out/RoutingStatusAlertContainer.html.md +3 -3
- data/doc_out/RoutingStatusRuleContainer.html.md +3 -3
- data/doc_out/RuleSetEntityListing.html.md +3 -3
- data/doc_out/RuleSetNotificationActions.html.md +2 -2
- data/doc_out/RuleSetNotificationConditions.html.md +4 -4
- data/doc_out/RuleSetNotificationRules.html.md +4 -4
- data/doc_out/SchemaCategoryEntityListing.html.md +3 -3
- data/doc_out/SchemaReferenceEntityListing.html.md +3 -3
- data/doc_out/ScreenRecordingSessionListing.html.md +3 -3
- data/doc_out/ScreenShareConversationNotificationErrorInfo.html.md +7 -7
- data/doc_out/ScreenShareConversationNotificationParticipants.html.md +18 -17
- data/doc_out/ScreenShareConversationNotificationScreenShareMediaParticipant.html.md +1 -0
- data/doc_out/ScreenShareConversationNotificationWrapup.html.md +18 -0
- data/doc_out/ScriptEntityListing.html.md +3 -3
- data/doc_out/ScriptsApi.html.md +10 -2
- data/doc_out/SearchApi.html.md +168 -48
- data/doc_out/SearchRequest.html.md +1 -1
- data/doc_out/SecurityProfileEntityListing.html.md +3 -3
- data/doc_out/ShareEntityListing.html.md +3 -3
- data/doc_out/SiteEntityListing.html.md +3 -3
- data/doc_out/SkillEntityListing.html.md +3 -3
- data/doc_out/SocialConversationNotificationErrorInfo.html.md +7 -7
- data/doc_out/SocialConversationNotificationParticipants.html.md +20 -19
- data/doc_out/SocialConversationNotificationSocialMediaParticipant.html.md +1 -0
- data/doc_out/SocialConversationNotificationWrapup.html.md +18 -0
- data/doc_out/StationEntityListing.html.md +3 -3
- data/doc_out/StatisticalResponse.html.md +1 -0
- data/doc_out/TagValueEntityListing.html.md +3 -3
- data/doc_out/TelephonyProvidersEdgeApi.html.md +347 -79
- data/doc_out/TimeOffRequestUpdateNotification.html.md +28 -0
- data/doc_out/TimeOffRequestUpdateNotificationUser.html.md +13 -0
- data/doc_out/TimeZoneEntityListing.html.md +3 -3
- data/doc_out/TransferRequest.html.md +1 -1
- data/doc_out/Trunk.html.md +2 -1
- data/doc_out/TrunkBase.html.md +1 -1
- data/doc_out/TrunkBaseEntityListing.html.md +3 -3
- data/doc_out/TrunkEntityListing.html.md +3 -3
- data/doc_out/TrunkMetabaseEntityListing.html.md +3 -3
- data/doc_out/TrunkMetrics.html.md +17 -0
- data/doc_out/TrunkMetricsCalls.html.md +14 -0
- data/doc_out/TrunkMetricsQoS.html.md +13 -0
- data/doc_out/User.html.md +1 -0
- data/doc_out/UserConversationSummaryNotificationCallContactCenter.html.md +1 -1
- data/doc_out/UserEntityListing.html.md +3 -3
- data/doc_out/UserMe.html.md +1 -0
- data/doc_out/UserPresenceAlertContainer.html.md +3 -3
- data/doc_out/UserPresenceNotificationPresenceDefinition.html.md +1 -1
- data/doc_out/UserPresenceRuleContainer.html.md +3 -3
- data/doc_out/UserQueueEntityListing.html.md +3 -3
- data/doc_out/UserRecordingEntityListing.html.md +3 -3
- data/doc_out/UserScheduleAdherenceUpdateNotification.html.md +22 -0
- data/doc_out/UserScheduleAdherenceUpdateNotificationUser.html.md +13 -0
- data/doc_out/UserSearchRequest.html.md +0 -1
- data/doc_out/UserSkillEntityListing.html.md +3 -3
- data/doc_out/UserStationsNotification.html.md +13 -0
- data/doc_out/UserStationsNotificationAssociatedStation.html.md +15 -0
- data/doc_out/UserStationsNotificationUser.html.md +13 -0
- data/doc_out/UserStationsNotificationUserStation.html.md +15 -0
- data/doc_out/UsersApi.html.md +2 -2
- data/doc_out/VideoConversationNotificationErrorInfo.html.md +7 -7
- data/doc_out/VideoConversationNotificationParticipants.html.md +20 -19
- data/doc_out/VideoConversationNotificationVideoMediaParticipant.html.md +1 -0
- data/doc_out/VideoConversationNotificationWrapup.html.md +18 -0
- data/doc_out/VoicemailMessageEntityListing.html.md +3 -3
- data/doc_out/VoicemailSearchRequest.html.md +0 -1
- data/doc_out/WorkforceManagementApi.html.md +15 -134
- data/doc_out/WorkspaceEntityListing.html.md +3 -3
- data/doc_out/WorkspaceMemberEntityListing.html.md +3 -3
- data/doc_out/WrapUpCodeMappingNotification.html.md +2 -3
- data/doc_out/WrapupCodeEntityListing.html.md +3 -3
- data/doc_out/index.html.md +3 -3
- data/lib/purecloud.rb +39 -15
- data/lib/purecloud/api/greetings_api.rb +5 -6
- data/lib/purecloud/api/groups_api.rb +5 -6
- data/lib/purecloud/api/identity_provider_api.rb +280 -96
- data/lib/purecloud/api/notifications_api.rb +9 -10
- data/lib/purecloud/api/o_auth_api.rb +6 -5
- data/lib/purecloud/api/organization_api.rb +23 -12
- data/lib/purecloud/api/outbound_api.rb +9 -9
- data/lib/purecloud/api/routing_api.rb +32 -297
- data/lib/purecloud/api/scripts_api.rb +9 -0
- data/lib/purecloud/api/search_api.rb +180 -59
- data/lib/purecloud/api/telephony_providers_edge_api.rb +368 -89
- data/lib/purecloud/api/users_api.rb +3 -3
- data/lib/purecloud/api/workforce_management_api.rb +20 -139
- data/lib/purecloud/api_client.rb +1 -1
- data/lib/purecloud/models/agent_activity_entity_listing.rb +23 -23
- data/lib/purecloud/models/aggregate_view_data.rb +175 -0
- data/lib/purecloud/models/aggregation_query.rb +17 -4
- data/lib/purecloud/models/analytics_view.rb +208 -0
- data/lib/purecloud/models/{entry_feature_boolean.rb → answer_option.rb} +23 -22
- data/lib/purecloud/models/attempt_limits_entity_listing.rb +23 -23
- data/lib/purecloud/models/attempt_limits_notification_recall_entries.rb +13 -13
- data/lib/purecloud/models/attribute_entity_listing.rb +23 -23
- data/lib/purecloud/models/available_topic.rb +22 -22
- data/lib/purecloud/models/calibration_entity_listing.rb +23 -23
- data/lib/purecloud/models/call_basic.rb +403 -0
- data/lib/purecloud/models/call_conversation_entity_listing.rb +23 -23
- data/lib/purecloud/models/call_conversation_notification_call_media_participant.rb +11 -1
- data/lib/purecloud/models/call_conversation_notification_error_info.rb +61 -61
- data/lib/purecloud/models/call_conversation_notification_fax_status.rb +39 -39
- data/lib/purecloud/models/call_conversation_notification_participants.rb +193 -183
- data/lib/purecloud/models/call_conversation_notification_wrapup.rb +217 -0
- data/lib/purecloud/models/call_media_participant.rb +12 -1
- data/lib/purecloud/models/callable_time_set_entity_listing.rb +23 -23
- data/lib/purecloud/models/callable_time_set_notification_callable_times.rb +14 -14
- data/lib/purecloud/models/callable_time_set_notification_time_slots.rb +14 -14
- data/lib/purecloud/models/callback_basic.rb +384 -0
- data/lib/purecloud/models/callback_conversation_entity_listing.rb +23 -23
- data/lib/purecloud/models/callback_conversation_notification_callback_media_participant.rb +11 -1
- data/lib/purecloud/models/callback_conversation_notification_error_info.rb +61 -61
- data/lib/purecloud/models/callback_conversation_notification_error_info_details.rb +23 -23
- data/lib/purecloud/models/callback_conversation_notification_participants.rb +185 -175
- data/lib/purecloud/models/callback_conversation_notification_wrapup.rb +217 -0
- data/lib/purecloud/models/callback_media_participant.rb +12 -1
- data/lib/purecloud/models/campaign_entity_listing.rb +23 -23
- data/lib/purecloud/models/campaign_interaction.rb +1 -1
- data/lib/purecloud/models/campaign_notification_contact_sort.rb +14 -14
- data/lib/purecloud/models/campaign_notification_errors.rb +13 -13
- data/lib/purecloud/models/campaign_notification_phone_columns.rb +13 -13
- data/lib/purecloud/models/campaign_rule_action.rb +1 -1
- data/lib/purecloud/models/campaign_rule_entity_listing.rb +23 -23
- data/lib/purecloud/models/campaign_rule_notification_campaign_rule_action_entities.rb +25 -25
- data/lib/purecloud/models/campaign_rule_notification_campaign_rule_actions.rb +11 -11
- data/lib/purecloud/models/campaign_rule_notification_campaign_rule_conditions.rb +11 -11
- data/lib/purecloud/models/campaign_rule_notification_campaign_rule_entities.rb +15 -15
- data/lib/purecloud/models/campaign_schedule_notification_intervals.rb +13 -13
- data/lib/purecloud/models/campaign_sequence_entity_listing.rb +23 -23
- data/lib/purecloud/models/campaign_stats.rb +26 -4
- data/lib/purecloud/models/certificate_authority_entity_listing.rb +23 -23
- data/lib/purecloud/models/channel.rb +14 -14
- data/lib/purecloud/models/channel_entity_listing.rb +4 -94
- data/lib/purecloud/models/chat_conversation_entity_listing.rb +23 -23
- data/lib/purecloud/models/chat_conversation_notification_chat_media_participant.rb +11 -1
- data/lib/purecloud/models/chat_conversation_notification_error_info.rb +61 -61
- data/lib/purecloud/models/chat_conversation_notification_participants.rb +144 -134
- data/lib/purecloud/models/chat_conversation_notification_wrapup.rb +217 -0
- data/lib/purecloud/models/chat_media_participant.rb +12 -1
- data/lib/purecloud/models/cobrowse_conversation_entity_listing.rb +23 -23
- data/lib/purecloud/models/cobrowse_conversation_notification_cobrowse_media_participant.rb +11 -1
- data/lib/purecloud/models/cobrowse_conversation_notification_error_info.rb +61 -61
- data/lib/purecloud/models/cobrowse_conversation_notification_participants.rb +168 -158
- data/lib/purecloud/models/cobrowse_conversation_notification_wrapup.rb +217 -0
- data/lib/purecloud/models/cobrowse_media_participant.rb +12 -1
- data/lib/purecloud/models/command_status_entity_listing.rb +23 -23
- data/lib/purecloud/models/contact_list.rb +12 -1
- data/lib/purecloud/models/contact_list_entity_listing.rb +23 -23
- data/lib/purecloud/models/contact_list_notification_import_status.rb +27 -27
- data/lib/purecloud/models/contact_list_notification_phone_columns.rb +14 -14
- data/lib/purecloud/models/{edge_metrics_network.rb → conversation_basic.rb} +48 -37
- data/lib/purecloud/models/conversation_entity_listing.rb +23 -23
- data/lib/purecloud/models/conversation_notification_callbacks.rb +95 -95
- data/lib/purecloud/models/conversation_notification_calls.rb +117 -117
- data/lib/purecloud/models/conversation_notification_chats.rb +46 -46
- data/lib/purecloud/models/conversation_notification_cobrowsesessions.rb +71 -71
- data/lib/purecloud/models/conversation_notification_dialer_preview.rb +25 -25
- data/lib/purecloud/models/conversation_notification_disconnect_reasons.rb +11 -11
- data/lib/purecloud/models/conversation_notification_emails.rb +59 -59
- data/lib/purecloud/models/conversation_notification_error_info.rb +35 -35
- data/lib/purecloud/models/conversation_notification_fax_status.rb +39 -39
- data/lib/purecloud/models/conversation_notification_participants.rb +154 -154
- data/lib/purecloud/models/conversation_notification_screenshares.rb +55 -55
- data/lib/purecloud/models/conversation_notification_self.rb +27 -27
- data/lib/purecloud/models/conversation_notification_social_expressions.rb +57 -57
- data/lib/purecloud/models/conversation_notification_videos.rb +61 -61
- data/lib/purecloud/models/conversation_notification_wrapup.rb +35 -35
- data/lib/purecloud/models/create_email_request.rb +24 -4
- data/lib/purecloud/models/did_entity_listing.rb +23 -23
- data/lib/purecloud/models/did_pool_entity_listing.rb +23 -23
- data/lib/purecloud/models/dnc_list_create.rb +298 -0
- data/lib/purecloud/models/dnc_list_entity_listing.rb +23 -23
- data/lib/purecloud/models/document_audit_entity_listing.rb +23 -23
- data/lib/purecloud/models/document_data_v2_notification_created_by.rb +13 -13
- data/lib/purecloud/models/document_data_v2_notification_lock_info.rb +11 -11
- data/lib/purecloud/models/document_entity_listing.rb +23 -23
- data/lib/purecloud/models/documentation_result.rb +395 -0
- data/lib/purecloud/models/{forecast_search_criteria.rb → documentation_search_criteria.rb} +3 -3
- data/lib/purecloud/models/{forecast_search_request.rb → documentation_search_request.rb} +3 -42
- data/lib/purecloud/models/{decisions_file_metadata_entity_listing.rb → documentation_search_response.rb} +61 -60
- data/lib/purecloud/models/domain_edge_software_update_dto.rb +11 -1
- data/lib/purecloud/models/domain_edge_software_version_dto_entity_listing.rb +23 -23
- data/lib/purecloud/models/domain_entity_listing.rb +23 -23
- data/lib/purecloud/models/domain_entity_listing_evaluation_form.rb +23 -23
- data/lib/purecloud/models/domain_entity_listing_query_result.rb +23 -23
- 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 +23 -23
- data/lib/purecloud/models/edge_group_entity_listing.rb +23 -23
- data/lib/purecloud/models/edge_line_entity_listing.rb +23 -23
- data/lib/purecloud/models/{edge_metrics_disk.rb → edge_service_state_request.rb} +16 -27
- data/lib/purecloud/models/edge_trunk_base.rb +332 -0
- data/lib/purecloud/models/email_conversation_entity_listing.rb +23 -23
- data/lib/purecloud/models/email_conversation_notification_email_media_participant.rb +11 -1
- data/lib/purecloud/models/email_conversation_notification_error_info.rb +61 -61
- data/lib/purecloud/models/email_conversation_notification_participants.rb +147 -137
- data/lib/purecloud/models/email_conversation_notification_wrapup.rb +217 -0
- data/lib/purecloud/models/email_media_participant.rb +12 -1
- data/lib/purecloud/models/email_message_listing.rb +23 -23
- data/lib/purecloud/models/encryption_key_entity_listing.rb +23 -23
- data/lib/purecloud/models/endpoint_entity_listing.rb +23 -23
- data/lib/purecloud/models/entry.rb +10 -8
- data/lib/purecloud/models/evaluation_entity_listing.rb +23 -23
- data/lib/purecloud/models/evaluation_form_entity_listing.rb +23 -23
- data/lib/purecloud/models/evaluator_activity_entity_listing.rb +23 -23
- data/lib/purecloud/models/extension_entity_listing.rb +23 -23
- data/lib/purecloud/models/extension_pool_entity_listing.rb +23 -23
- data/lib/purecloud/models/fax_data_v2_notification_lock_info.rb +11 -11
- data/lib/purecloud/models/fax_document_entity_listing.rb +23 -23
- data/lib/purecloud/models/feature_state.rb +165 -0
- data/lib/purecloud/models/{decisions_download_metadata.rb → g_suite.rb} +32 -37
- data/lib/purecloud/models/geolocation.rb +13 -1
- data/lib/purecloud/models/greeting_listing.rb +23 -23
- data/lib/purecloud/models/group_entity_listing.rb +23 -23
- data/lib/purecloud/models/group_search_request.rb +1 -27
- data/lib/purecloud/models/heart_beat_alert_container.rb +23 -23
- data/lib/purecloud/models/heart_beat_alert_notification_notification_users.rb +13 -13
- data/lib/purecloud/models/heart_beat_rule_container.rb +23 -23
- data/lib/purecloud/models/inbound_domain_entity_listing.rb +23 -23
- data/lib/purecloud/models/inbound_route_entity_listing.rb +23 -23
- data/lib/purecloud/models/interaction_stats_alert_container.rb +23 -23
- data/lib/purecloud/models/interaction_stats_rule_container.rb +23 -23
- data/lib/purecloud/models/json_node.rb +34 -34
- data/lib/purecloud/models/keyword_set.rb +1 -11
- data/lib/purecloud/models/keyword_set_entity_listing.rb +23 -23
- data/lib/purecloud/models/language_entity_listing.rb +23 -23
- data/lib/purecloud/models/library_entity_listing.rb +23 -23
- data/lib/purecloud/models/line_base_entity_listing.rb +23 -23
- data/lib/purecloud/models/line_entity_listing.rb +23 -23
- data/lib/purecloud/models/local_encryption_configuration_listing.rb +13 -83
- data/lib/purecloud/models/location_search_request.rb +1 -27
- data/lib/purecloud/models/logical_interface_entity_listing.rb +23 -23
- data/lib/purecloud/models/o_auth_client_entity_listing.rb +23 -23
- data/lib/purecloud/models/o_auth_provider_entity_listing.rb +23 -23
- data/lib/purecloud/models/organization_features.rb +285 -0
- data/lib/purecloud/models/organization_presence_entity_listing.rb +23 -23
- data/lib/purecloud/models/organization_role_entity_listing.rb +23 -23
- data/lib/purecloud/models/orphan_recording_listing.rb +23 -23
- data/lib/purecloud/models/outbound_route_base_entity_listing.rb +23 -23
- data/lib/purecloud/models/outbound_route_entity_listing.rb +23 -23
- data/lib/purecloud/models/participant_basic.rb +571 -0
- data/lib/purecloud/models/permission_collection_entity_listing.rb +23 -23
- data/lib/purecloud/models/phone_base_entity_listing.rb +23 -23
- data/lib/purecloud/models/phone_entity_listing.rb +23 -23
- data/lib/purecloud/models/phone_meta_base_entity_listing.rb +23 -23
- data/lib/purecloud/models/physical_interface_entity_listing.rb +23 -23
- data/lib/purecloud/models/ping_identity.rb +237 -0
- data/lib/purecloud/models/policy_entity_listing.rb +23 -23
- data/lib/purecloud/models/prediction_results.rb +22 -2
- data/lib/purecloud/models/quality_audit.rb +11 -11
- data/lib/purecloud/models/quality_audit_page.rb +23 -23
- data/lib/purecloud/models/{billing_task_result_notification.rb → question.rb} +80 -66
- data/lib/purecloud/models/question_group.rb +1 -1
- data/lib/purecloud/models/queue_entity_listing.rb +23 -23
- data/lib/purecloud/models/queue_member.rb +1 -1
- data/lib/purecloud/models/queue_member_entity_listing.rb +23 -23
- data/lib/purecloud/models/recording_data_v2_notification_lock_info.rb +11 -11
- data/lib/purecloud/models/report_meta_data_entity_listing.rb +23 -23
- data/lib/purecloud/models/report_run_entry.rb +1 -1
- data/lib/purecloud/models/report_run_entry_entity_domain_listing.rb +23 -23
- data/lib/purecloud/models/report_schedule_entity_listing.rb +23 -23
- data/lib/purecloud/models/response.rb +14 -1
- data/lib/purecloud/models/response_entity_list.rb +23 -23
- data/lib/purecloud/models/response_entity_listing.rb +23 -23
- data/lib/purecloud/models/response_set_entity_listing.rb +23 -23
- data/lib/purecloud/models/response_set_notification_responses.rb +23 -23
- data/lib/purecloud/models/{forecast_creation_completion.rb → response_substitution.rb} +21 -29
- data/lib/purecloud/models/routing_status_alert_container.rb +23 -23
- data/lib/purecloud/models/routing_status_rule_container.rb +23 -23
- data/lib/purecloud/models/rule_set_entity_listing.rb +23 -23
- data/lib/purecloud/models/rule_set_notification_actions.rb +23 -23
- data/lib/purecloud/models/rule_set_notification_conditions.rb +35 -35
- data/lib/purecloud/models/rule_set_notification_rules.rb +37 -37
- data/lib/purecloud/models/schema_category_entity_listing.rb +23 -23
- data/lib/purecloud/models/schema_reference_entity_listing.rb +23 -23
- data/lib/purecloud/models/screen_recording_session_listing.rb +23 -23
- data/lib/purecloud/models/screen_share_conversation_notification_error_info.rb +61 -61
- data/lib/purecloud/models/screen_share_conversation_notification_participants.rb +159 -149
- data/lib/purecloud/models/screen_share_conversation_notification_screen_share_media_participant.rb +11 -1
- data/lib/purecloud/models/screen_share_conversation_notification_wrapup.rb +217 -0
- data/lib/purecloud/models/script_entity_listing.rb +23 -23
- data/lib/purecloud/models/search_request.rb +1 -1
- data/lib/purecloud/models/security_profile_entity_listing.rb +23 -23
- data/lib/purecloud/models/share_entity_listing.rb +23 -23
- data/lib/purecloud/models/site_entity_listing.rb +23 -23
- data/lib/purecloud/models/skill_entity_listing.rb +23 -23
- data/lib/purecloud/models/social_conversation_notification_error_info.rb +61 -61
- data/lib/purecloud/models/social_conversation_notification_participants.rb +158 -148
- data/lib/purecloud/models/social_conversation_notification_social_media_participant.rb +11 -1
- data/lib/purecloud/models/social_conversation_notification_wrapup.rb +217 -0
- data/lib/purecloud/models/station_entity_listing.rb +23 -23
- data/lib/purecloud/models/statistical_response.rb +16 -4
- data/lib/purecloud/models/tag_value_entity_listing.rb +23 -23
- data/lib/purecloud/models/time_off_request_update_notification.rb +328 -0
- data/lib/purecloud/models/{decisions_download_link.rb → time_off_request_update_notification_user.rb} +5 -17
- data/lib/purecloud/models/time_zone_entity_listing.rb +23 -23
- data/lib/purecloud/models/transfer_request.rb +1 -1
- data/lib/purecloud/models/trunk.rb +12 -1
- data/lib/purecloud/models/trunk_base.rb +1 -1
- data/lib/purecloud/models/trunk_base_entity_listing.rb +23 -23
- data/lib/purecloud/models/trunk_entity_listing.rb +23 -23
- data/lib/purecloud/models/trunk_metabase_entity_listing.rb +23 -23
- data/lib/purecloud/models/trunk_metrics.rb +206 -0
- data/lib/purecloud/models/trunk_metrics_calls.rb +175 -0
- data/lib/purecloud/models/trunk_metrics_qo_s.rb +166 -0
- data/lib/purecloud/models/user.rb +14 -1
- data/lib/purecloud/models/user_conversation_summary_notification_call_contact_center.rb +13 -13
- data/lib/purecloud/models/user_entity_listing.rb +23 -23
- data/lib/purecloud/models/user_me.rb +14 -1
- data/lib/purecloud/models/user_presence_alert_container.rb +23 -23
- data/lib/purecloud/models/user_presence_notification_presence_definition.rb +13 -13
- data/lib/purecloud/models/user_presence_rule_container.rb +23 -23
- data/lib/purecloud/models/user_queue_entity_listing.rb +23 -23
- data/lib/purecloud/models/user_recording_entity_listing.rb +23 -23
- data/lib/purecloud/models/{forecast_creation.rb → user_schedule_adherence_update_notification.rb} +81 -49
- data/lib/purecloud/models/user_schedule_adherence_update_notification_user.rb +165 -0
- data/lib/purecloud/models/user_search_request.rb +1 -14
- data/lib/purecloud/models/user_skill_entity_listing.rb +23 -23
- data/lib/purecloud/models/user_stations_notification.rb +165 -0
- data/lib/purecloud/models/{edge_metrics_memory.rb → user_stations_notification_associated_station.rb} +20 -23
- data/lib/purecloud/models/user_stations_notification_user.rb +165 -0
- data/lib/purecloud/models/{edge_metrics_subsystem.rb → user_stations_notification_user_station.rb} +20 -23
- data/lib/purecloud/models/video_conversation_notification_error_info.rb +61 -61
- data/lib/purecloud/models/video_conversation_notification_participants.rb +161 -151
- data/lib/purecloud/models/video_conversation_notification_video_media_participant.rb +11 -1
- data/lib/purecloud/models/video_conversation_notification_wrapup.rb +217 -0
- data/lib/purecloud/models/voicemail_message_entity_listing.rb +23 -23
- data/lib/purecloud/models/voicemail_search_request.rb +1 -14
- data/lib/purecloud/models/workspace_entity_listing.rb +23 -23
- data/lib/purecloud/models/workspace_member_entity_listing.rb +23 -23
- data/lib/purecloud/models/wrap_up_code_mapping_notification.rb +27 -46
- data/lib/purecloud/models/wrapup_code_entity_listing.rb +23 -23
- data/lib/purecloud/version.rb +1 -1
- data/newVersion.md +1 -1
- data/swagger.json +1 -1
- data/version.json +1 -1
- metadata +80 -32
- data/doc_out/BillingTaskResultNotification.html.md +0 -21
- data/doc_out/DecisionsDownloadLink.html.md +0 -14
- data/doc_out/DecisionsDownloadMetadata.html.md +0 -20
- data/doc_out/DecisionsFileMetadataEntityListing.html.md +0 -22
- data/doc_out/EdgeMetrics.html.md +0 -20
- data/doc_out/EdgeMetricsDisk.html.md +0 -15
- data/doc_out/EdgeMetricsMemory.html.md +0 -15
- data/doc_out/EdgeMetricsNetwork.html.md +0 -17
- data/doc_out/EdgeMetricsProcessor.html.md +0 -17
- data/doc_out/EdgeMetricsSubsystem.html.md +0 -15
- data/doc_out/ForecastCreation.html.md +0 -18
- data/doc_out/ForecastCreationCompletion.html.md +0 -15
- data/lib/purecloud/models/edge_metrics.rb +0 -246
- data/lib/purecloud/models/edge_metrics_processor.rb +0 -210
@@ -11,11 +11,11 @@ title: ReportScheduleEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
18
16
|
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **previous_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/Response.html.md
CHANGED
@@ -15,6 +15,7 @@ title: Response
|
|
15
15
|
| **created_by** | [**User**](User.html) | User that created the response | [optional] |
|
16
16
|
| **date_created** | **DateTime** | The date and time the response was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
17
17
|
| **interaction_type** | **String** | The interaction type for this response. | [optional] |
|
18
|
+
| **substitutions** | [**Array<ResponseSubstitution>**](ResponseSubstitution.html) | Details about any text substitutions used in the texts for this response. | [optional] |
|
18
19
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
19
20
|
{: class="table table-striped"}
|
20
21
|
|
@@ -11,11 +11,11 @@ title: ResponseEntityList
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
18
16
|
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **previous_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: ResponseEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
18
16
|
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **previous_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: ResponseSetEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
18
16
|
| **last_uri** | **String** | | [optional] |
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -7,10 +7,10 @@ title: ResponseSetNotificationResponses
|
|
7
7
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **additional_properties** | **Object** | | [optional] |
|
11
|
-
| **name** | **String** | | [optional] |
|
12
10
|
| **data** | **String** | | [optional] |
|
13
11
|
| **reaction_type** | **String** | | [optional] |
|
12
|
+
| **name** | **String** | | [optional] |
|
13
|
+
| **additional_properties** | **Object** | | [optional] |
|
14
14
|
{: class="table table-striped"}
|
15
15
|
|
16
16
|
|
@@ -0,0 +1,15 @@
|
|
1
|
+
---
|
2
|
+
title: ResponseSubstitution
|
3
|
+
---
|
4
|
+
## PureCloud::ResponseSubstitution
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **id** | **String** | Response substitution identifier. | |
|
11
|
+
| **description** | **String** | Response substitution description. | [optional] |
|
12
|
+
| **default_value** | **String** | Response substitution default value. | [optional] |
|
13
|
+
{: class="table table-striped"}
|
14
|
+
|
15
|
+
|
data/doc_out/RoutingApi.html.md
CHANGED
@@ -25,12 +25,8 @@ Method | Description
|
|
25
25
|
[**get_languages**](RoutingApi.html#get_languages) | Get the list of supported languages.
|
26
26
|
[**get_queues**](RoutingApi.html#get_queues) | Get list of queues.
|
27
27
|
[**get_queues_queue_id**](RoutingApi.html#get_queues_queue_id) | Get details about this queue.
|
28
|
-
[**get_queues_queue_id_conversations**](RoutingApi.html#get_queues_queue_id_conversations) | Get recent conversations that are still active
|
29
|
-
[**get_queues_queue_id_conversations_callbacks**](RoutingApi.html#get_queues_queue_id_conversations_callbacks) | Get recent callback conversations that are still active
|
30
|
-
[**get_queues_queue_id_conversations_calls**](RoutingApi.html#get_queues_queue_id_conversations_calls) | Get recent call conversations that are still active
|
31
|
-
[**get_queues_queue_id_conversations_chats**](RoutingApi.html#get_queues_queue_id_conversations_chats) | Get recent chat conversations that are still active
|
32
|
-
[**get_queues_queue_id_conversations_emails**](RoutingApi.html#get_queues_queue_id_conversations_emails) | Get recent email conversations that are still active
|
33
28
|
[**get_queues_queue_id_estimatedwaittime**](RoutingApi.html#get_queues_queue_id_estimatedwaittime) | Get Estimated Wait Time
|
29
|
+
[**get_queues_queue_id_mediatypes_mediatype_estimatedwaittime**](RoutingApi.html#get_queues_queue_id_mediatypes_mediatype_estimatedwaittime) | Get Estimated Wait Time
|
34
30
|
[**get_queues_queue_id_users**](RoutingApi.html#get_queues_queue_id_users) | Get the members of this queue
|
35
31
|
[**get_queues_queue_id_wrapupcodes**](RoutingApi.html#get_queues_queue_id_wrapupcodes) | Get the wrap-up codes for a queue
|
36
32
|
[**get_skills**](RoutingApi.html#get_skills) | Get the list of routing skills.
|
@@ -1086,275 +1082,15 @@ Name | Type | Description | Notes
|
|
1086
1082
|
|
1087
1083
|
|
1088
1084
|
|
1089
|
-
<a name="
|
1090
|
-
|
1091
|
-
## -[**ConversationEntityListing**](ConversationEntityListing.html) get_queues_queue_id_conversations(queue_id, opts)
|
1092
|
-
|
1093
|
-
Get recent conversations that are still active
|
1094
|
-
|
1095
|
-
|
1096
|
-
|
1097
|
-
Wraps GET /api/v2/routing/queues/{queueId}/conversations
|
1098
|
-
|
1099
|
-
|
1100
|
-
### Example
|
1101
|
-
~~~ruby
|
1102
|
-
# load the gem
|
1103
|
-
require 'purecloud'
|
1104
|
-
# setup authorization
|
1105
|
-
@secret = ENV['PURECLOUD_SECRET']
|
1106
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
1107
|
-
environment = "mypurecloud.com"
|
1108
|
-
|
1109
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1110
|
-
|
1111
|
-
PureCloud.configure do |config|
|
1112
|
-
config.access_token = @authToken
|
1113
|
-
end
|
1114
|
-
|
1115
|
-
api_instance = PureCloud::RoutingApi.new
|
1116
|
-
|
1117
|
-
queue_id = "queue_id_example" # String | Queue ID
|
1118
|
-
|
1119
|
-
opts = {
|
1120
|
-
page_size: 25, # Integer | Page size
|
1121
|
-
page_number: 1 # Integer | Page number
|
1122
|
-
}
|
1123
|
-
|
1124
|
-
begin
|
1125
|
-
#Get recent conversations that are still active
|
1126
|
-
result = api_instance.get_queues_queue_id_conversations(queue_id, opts)
|
1127
|
-
p result
|
1128
|
-
rescue PureCloud::ApiError => e
|
1129
|
-
puts "Exception when calling RoutingApi->get_queues_queue_id_conversations: #{e}"
|
1130
|
-
end
|
1131
|
-
~~~
|
1132
|
-
|
1133
|
-
### Parameters
|
1134
|
-
|
1135
|
-
Name | Type | Description | Notes
|
1136
|
-
------------- | ------------- | ------------- | -------------
|
1137
|
-
**queue_id** | **String**| Queue ID |
|
1138
|
-
**page_size** | **Integer**| Page size | [optional] [default to 25]
|
1139
|
-
**page_number** | **Integer**| Page number | [optional] [default to 1]
|
1140
|
-
{: class="table table-striped"}
|
1141
|
-
|
1142
|
-
|
1143
|
-
### Return type
|
1144
|
-
|
1145
|
-
[**ConversationEntityListing**](ConversationEntityListing.html)
|
1146
|
-
|
1147
|
-
### HTTP request headers
|
1148
|
-
|
1149
|
-
- **Content-Type**: application/json
|
1150
|
-
- **Accept**: application/json
|
1151
|
-
|
1152
|
-
|
1153
|
-
|
1154
|
-
<a name="get_queues_queue_id_conversations_callbacks"></a>
|
1155
|
-
|
1156
|
-
## -[**CallbackConversationEntityListing**](CallbackConversationEntityListing.html) get_queues_queue_id_conversations_callbacks(queue_id, opts)
|
1157
|
-
|
1158
|
-
Get recent callback conversations that are still active
|
1159
|
-
|
1160
|
-
|
1161
|
-
|
1162
|
-
Wraps GET /api/v2/routing/queues/{queueId}/conversations/callbacks
|
1163
|
-
|
1164
|
-
|
1165
|
-
### Example
|
1166
|
-
~~~ruby
|
1167
|
-
# load the gem
|
1168
|
-
require 'purecloud'
|
1169
|
-
# setup authorization
|
1170
|
-
@secret = ENV['PURECLOUD_SECRET']
|
1171
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
1172
|
-
environment = "mypurecloud.com"
|
1173
|
-
|
1174
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1175
|
-
|
1176
|
-
PureCloud.configure do |config|
|
1177
|
-
config.access_token = @authToken
|
1178
|
-
end
|
1179
|
-
|
1180
|
-
api_instance = PureCloud::RoutingApi.new
|
1181
|
-
|
1182
|
-
queue_id = "queue_id_example" # String | Queue ID
|
1183
|
-
|
1184
|
-
opts = {
|
1185
|
-
page_size: 25, # Integer | Page size
|
1186
|
-
page_number: 1 # Integer | Page number
|
1187
|
-
}
|
1188
|
-
|
1189
|
-
begin
|
1190
|
-
#Get recent callback conversations that are still active
|
1191
|
-
result = api_instance.get_queues_queue_id_conversations_callbacks(queue_id, opts)
|
1192
|
-
p result
|
1193
|
-
rescue PureCloud::ApiError => e
|
1194
|
-
puts "Exception when calling RoutingApi->get_queues_queue_id_conversations_callbacks: #{e}"
|
1195
|
-
end
|
1196
|
-
~~~
|
1197
|
-
|
1198
|
-
### Parameters
|
1199
|
-
|
1200
|
-
Name | Type | Description | Notes
|
1201
|
-
------------- | ------------- | ------------- | -------------
|
1202
|
-
**queue_id** | **String**| Queue ID |
|
1203
|
-
**page_size** | **Integer**| Page size | [optional] [default to 25]
|
1204
|
-
**page_number** | **Integer**| Page number | [optional] [default to 1]
|
1205
|
-
{: class="table table-striped"}
|
1206
|
-
|
1207
|
-
|
1208
|
-
### Return type
|
1209
|
-
|
1210
|
-
[**CallbackConversationEntityListing**](CallbackConversationEntityListing.html)
|
1211
|
-
|
1212
|
-
### HTTP request headers
|
1213
|
-
|
1214
|
-
- **Content-Type**: application/json
|
1215
|
-
- **Accept**: application/json
|
1216
|
-
|
1217
|
-
|
1218
|
-
|
1219
|
-
<a name="get_queues_queue_id_conversations_calls"></a>
|
1220
|
-
|
1221
|
-
## -[**CallConversationEntityListing**](CallConversationEntityListing.html) get_queues_queue_id_conversations_calls(queue_id, opts)
|
1222
|
-
|
1223
|
-
Get recent call conversations that are still active
|
1224
|
-
|
1225
|
-
|
1226
|
-
|
1227
|
-
Wraps GET /api/v2/routing/queues/{queueId}/conversations/calls
|
1228
|
-
|
1229
|
-
|
1230
|
-
### Example
|
1231
|
-
~~~ruby
|
1232
|
-
# load the gem
|
1233
|
-
require 'purecloud'
|
1234
|
-
# setup authorization
|
1235
|
-
@secret = ENV['PURECLOUD_SECRET']
|
1236
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
1237
|
-
environment = "mypurecloud.com"
|
1238
|
-
|
1239
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1240
|
-
|
1241
|
-
PureCloud.configure do |config|
|
1242
|
-
config.access_token = @authToken
|
1243
|
-
end
|
1244
|
-
|
1245
|
-
api_instance = PureCloud::RoutingApi.new
|
1246
|
-
|
1247
|
-
queue_id = "queue_id_example" # String | Queue ID
|
1248
|
-
|
1249
|
-
opts = {
|
1250
|
-
page_size: 25, # Integer | Page size
|
1251
|
-
page_number: 1 # Integer | Page number
|
1252
|
-
}
|
1253
|
-
|
1254
|
-
begin
|
1255
|
-
#Get recent call conversations that are still active
|
1256
|
-
result = api_instance.get_queues_queue_id_conversations_calls(queue_id, opts)
|
1257
|
-
p result
|
1258
|
-
rescue PureCloud::ApiError => e
|
1259
|
-
puts "Exception when calling RoutingApi->get_queues_queue_id_conversations_calls: #{e}"
|
1260
|
-
end
|
1261
|
-
~~~
|
1262
|
-
|
1263
|
-
### Parameters
|
1264
|
-
|
1265
|
-
Name | Type | Description | Notes
|
1266
|
-
------------- | ------------- | ------------- | -------------
|
1267
|
-
**queue_id** | **String**| Queue ID |
|
1268
|
-
**page_size** | **Integer**| Page size | [optional] [default to 25]
|
1269
|
-
**page_number** | **Integer**| Page number | [optional] [default to 1]
|
1270
|
-
{: class="table table-striped"}
|
1271
|
-
|
1272
|
-
|
1273
|
-
### Return type
|
1274
|
-
|
1275
|
-
[**CallConversationEntityListing**](CallConversationEntityListing.html)
|
1276
|
-
|
1277
|
-
### HTTP request headers
|
1278
|
-
|
1279
|
-
- **Content-Type**: application/json
|
1280
|
-
- **Accept**: application/json
|
1281
|
-
|
1282
|
-
|
1283
|
-
|
1284
|
-
<a name="get_queues_queue_id_conversations_chats"></a>
|
1285
|
-
|
1286
|
-
## -[**ChatConversationEntityListing**](ChatConversationEntityListing.html) get_queues_queue_id_conversations_chats(queue_id, opts)
|
1287
|
-
|
1288
|
-
Get recent chat conversations that are still active
|
1289
|
-
|
1290
|
-
|
1291
|
-
|
1292
|
-
Wraps GET /api/v2/routing/queues/{queueId}/conversations/chats
|
1293
|
-
|
1294
|
-
|
1295
|
-
### Example
|
1296
|
-
~~~ruby
|
1297
|
-
# load the gem
|
1298
|
-
require 'purecloud'
|
1299
|
-
# setup authorization
|
1300
|
-
@secret = ENV['PURECLOUD_SECRET']
|
1301
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
1302
|
-
environment = "mypurecloud.com"
|
1303
|
-
|
1304
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1305
|
-
|
1306
|
-
PureCloud.configure do |config|
|
1307
|
-
config.access_token = @authToken
|
1308
|
-
end
|
1309
|
-
|
1310
|
-
api_instance = PureCloud::RoutingApi.new
|
1311
|
-
|
1312
|
-
queue_id = "queue_id_example" # String | Queue ID
|
1313
|
-
|
1314
|
-
opts = {
|
1315
|
-
page_size: 25, # Integer | Page size
|
1316
|
-
page_number: 1 # Integer | Page number
|
1317
|
-
}
|
1318
|
-
|
1319
|
-
begin
|
1320
|
-
#Get recent chat conversations that are still active
|
1321
|
-
result = api_instance.get_queues_queue_id_conversations_chats(queue_id, opts)
|
1322
|
-
p result
|
1323
|
-
rescue PureCloud::ApiError => e
|
1324
|
-
puts "Exception when calling RoutingApi->get_queues_queue_id_conversations_chats: #{e}"
|
1325
|
-
end
|
1326
|
-
~~~
|
1327
|
-
|
1328
|
-
### Parameters
|
1329
|
-
|
1330
|
-
Name | Type | Description | Notes
|
1331
|
-
------------- | ------------- | ------------- | -------------
|
1332
|
-
**queue_id** | **String**| Queue ID |
|
1333
|
-
**page_size** | **Integer**| Page size | [optional] [default to 25]
|
1334
|
-
**page_number** | **Integer**| Page number | [optional] [default to 1]
|
1335
|
-
{: class="table table-striped"}
|
1336
|
-
|
1337
|
-
|
1338
|
-
### Return type
|
1339
|
-
|
1340
|
-
[**ChatConversationEntityListing**](ChatConversationEntityListing.html)
|
1341
|
-
|
1342
|
-
### HTTP request headers
|
1343
|
-
|
1344
|
-
- **Content-Type**: application/json
|
1345
|
-
- **Accept**: application/json
|
1346
|
-
|
1347
|
-
|
1348
|
-
|
1349
|
-
<a name="get_queues_queue_id_conversations_emails"></a>
|
1085
|
+
<a name="get_queues_queue_id_estimatedwaittime"></a>
|
1350
1086
|
|
1351
|
-
## -[**
|
1087
|
+
## -[**EstimatedWaitTimePredictions**](EstimatedWaitTimePredictions.html) get_queues_queue_id_estimatedwaittime(queue_id, opts)
|
1352
1088
|
|
1353
|
-
Get
|
1089
|
+
Get Estimated Wait Time
|
1354
1090
|
|
1355
1091
|
|
1356
1092
|
|
1357
|
-
Wraps GET /api/v2/routing/queues/{queueId}/
|
1093
|
+
Wraps GET /api/v2/routing/queues/{queueId}/estimatedwaittime
|
1358
1094
|
|
1359
1095
|
|
1360
1096
|
### Example
|
@@ -1374,19 +1110,18 @@ end
|
|
1374
1110
|
|
1375
1111
|
api_instance = PureCloud::RoutingApi.new
|
1376
1112
|
|
1377
|
-
queue_id = "queue_id_example" # String |
|
1113
|
+
queue_id = "queue_id_example" # String | queueId
|
1378
1114
|
|
1379
1115
|
opts = {
|
1380
|
-
|
1381
|
-
page_number: 1 # Integer | Page number
|
1116
|
+
conversation_id: "conversation_id_example" # String | conversationId
|
1382
1117
|
}
|
1383
1118
|
|
1384
1119
|
begin
|
1385
|
-
#Get
|
1386
|
-
result = api_instance.
|
1120
|
+
#Get Estimated Wait Time
|
1121
|
+
result = api_instance.get_queues_queue_id_estimatedwaittime(queue_id, opts)
|
1387
1122
|
p result
|
1388
1123
|
rescue PureCloud::ApiError => e
|
1389
|
-
puts "Exception when calling RoutingApi->
|
1124
|
+
puts "Exception when calling RoutingApi->get_queues_queue_id_estimatedwaittime: #{e}"
|
1390
1125
|
end
|
1391
1126
|
~~~
|
1392
1127
|
|
@@ -1394,15 +1129,14 @@ end
|
|
1394
1129
|
|
1395
1130
|
Name | Type | Description | Notes
|
1396
1131
|
------------- | ------------- | ------------- | -------------
|
1397
|
-
**queue_id** | **String**|
|
1398
|
-
**
|
1399
|
-
**page_number** | **Integer**| Page number | [optional] [default to 1]
|
1132
|
+
**queue_id** | **String**| queueId |
|
1133
|
+
**conversation_id** | **String**| conversationId | [optional]
|
1400
1134
|
{: class="table table-striped"}
|
1401
1135
|
|
1402
1136
|
|
1403
1137
|
### Return type
|
1404
1138
|
|
1405
|
-
[**
|
1139
|
+
[**EstimatedWaitTimePredictions**](EstimatedWaitTimePredictions.html)
|
1406
1140
|
|
1407
1141
|
### HTTP request headers
|
1408
1142
|
|
@@ -1411,15 +1145,15 @@ Name | Type | Description | Notes
|
|
1411
1145
|
|
1412
1146
|
|
1413
1147
|
|
1414
|
-
<a name="
|
1148
|
+
<a name="get_queues_queue_id_mediatypes_mediatype_estimatedwaittime"></a>
|
1415
1149
|
|
1416
|
-
## -[**EstimatedWaitTimePredictions**](EstimatedWaitTimePredictions.html)
|
1150
|
+
## -[**EstimatedWaitTimePredictions**](EstimatedWaitTimePredictions.html) get_queues_queue_id_mediatypes_mediatype_estimatedwaittime(queue_id, media_type)
|
1417
1151
|
|
1418
1152
|
Get Estimated Wait Time
|
1419
1153
|
|
1420
1154
|
|
1421
1155
|
|
1422
|
-
Wraps GET /api/v2/routing/queues/{queueId}/estimatedwaittime
|
1156
|
+
Wraps GET /api/v2/routing/queues/{queueId}/mediatypes/{mediaType}/estimatedwaittime
|
1423
1157
|
|
1424
1158
|
|
1425
1159
|
### Example
|
@@ -1441,16 +1175,15 @@ api_instance = PureCloud::RoutingApi.new
|
|
1441
1175
|
|
1442
1176
|
queue_id = "queue_id_example" # String | queueId
|
1443
1177
|
|
1444
|
-
|
1445
|
-
|
1446
|
-
}
|
1178
|
+
media_type = "media_type_example" # String | mediaType
|
1179
|
+
|
1447
1180
|
|
1448
1181
|
begin
|
1449
1182
|
#Get Estimated Wait Time
|
1450
|
-
result = api_instance.
|
1183
|
+
result = api_instance.get_queues_queue_id_mediatypes_mediatype_estimatedwaittime(queue_id, media_type)
|
1451
1184
|
p result
|
1452
1185
|
rescue PureCloud::ApiError => e
|
1453
|
-
puts "Exception when calling RoutingApi->
|
1186
|
+
puts "Exception when calling RoutingApi->get_queues_queue_id_mediatypes_mediatype_estimatedwaittime: #{e}"
|
1454
1187
|
end
|
1455
1188
|
~~~
|
1456
1189
|
|
@@ -1459,7 +1192,7 @@ end
|
|
1459
1192
|
Name | Type | Description | Notes
|
1460
1193
|
------------- | ------------- | ------------- | -------------
|
1461
1194
|
**queue_id** | **String**| queueId |
|
1462
|
-
**
|
1195
|
+
**media_type** | **String**| mediaType |
|
1463
1196
|
{: class="table table-striped"}
|
1464
1197
|
|
1465
1198
|
|
@@ -2658,7 +2391,7 @@ Name | Type | Description | Notes
|
|
2658
2391
|
|
2659
2392
|
<a name="post_wrapupcodes"></a>
|
2660
2393
|
|
2661
|
-
## -[**
|
2394
|
+
## -[**WrapupCode**](WrapupCode.html) post_wrapupcodes(body)
|
2662
2395
|
|
2663
2396
|
Create a wrap-up code
|
2664
2397
|
|
@@ -2706,7 +2439,7 @@ Name | Type | Description | Notes
|
|
2706
2439
|
|
2707
2440
|
### Return type
|
2708
2441
|
|
2709
|
-
[**
|
2442
|
+
[**WrapupCode**](WrapupCode.html)
|
2710
2443
|
|
2711
2444
|
### HTTP request headers
|
2712
2445
|
|