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: RoutingStatusAlertContainer
|
|
|
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: RoutingStatusRuleContainer
|
|
|
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: RuleSetEntityListing
|
|
|
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,11 +7,11 @@ title: RuleSetNotificationActions
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **update_option** | **String** | | [optional] |
|
|
11
10
|
| **action_type_name** | **String** | | [optional] |
|
|
11
|
+
| **update_option** | **String** | | [optional] |
|
|
12
12
|
| **additional_properties** | **Object** | | [optional] |
|
|
13
|
-
| **properties** | **Hash<String, String>** | | [optional] |
|
|
14
13
|
| **type** | **String** | | [optional] |
|
|
14
|
+
| **properties** | **Hash<String, String>** | | [optional] |
|
|
15
15
|
{: class="table table-striped"}
|
|
16
16
|
|
|
17
17
|
|
|
@@ -7,13 +7,13 @@ title: RuleSetNotificationConditions
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **attribute_name** | **String** | | [optional] |
|
|
11
|
-
| **additional_properties** | **Object** | | [optional] |
|
|
12
|
-
| **value** | **String** | | [optional] |
|
|
13
10
|
| **codes** | **Array<String>** | | [optional] |
|
|
14
11
|
| **value_type** | **String** | | [optional] |
|
|
15
|
-
| **
|
|
12
|
+
| **attribute_name** | **String** | | [optional] |
|
|
13
|
+
| **additional_properties** | **Object** | | [optional] |
|
|
16
14
|
| **type** | **String** | | [optional] |
|
|
15
|
+
| **inverted** | **BOOLEAN** | | [optional] |
|
|
16
|
+
| **value** | **String** | | [optional] |
|
|
17
17
|
| **operator** | **String** | | [optional] |
|
|
18
18
|
{: class="table table-striped"}
|
|
19
19
|
|
|
@@ -7,13 +7,13 @@ title: RuleSetNotificationRules
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **
|
|
10
|
+
| **name** | **String** | | [optional] |
|
|
11
11
|
| **id** | **String** | | [optional] |
|
|
12
|
-
| **category** | **String** | | [optional] |
|
|
13
|
-
| **order** | **Integer** | | [optional] |
|
|
14
12
|
| **additional_properties** | **Object** | | [optional] |
|
|
15
|
-
| **
|
|
13
|
+
| **category** | **String** | | [optional] |
|
|
14
|
+
| **conditions** | [**Array<RuleSetNotificationConditions>**](RuleSetNotificationConditions.html) | | [optional] |
|
|
16
15
|
| **actions** | [**Array<RuleSetNotificationActions>**](RuleSetNotificationActions.html) | | [optional] |
|
|
16
|
+
| **order** | **Integer** | | [optional] |
|
|
17
17
|
{: class="table table-striped"}
|
|
18
18
|
|
|
19
19
|
|
|
@@ -11,11 +11,11 @@ title: SchemaCategoryEntityListing
|
|
|
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: SchemaReferenceEntityListing
|
|
|
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: ScreenRecordingSessionListing
|
|
|
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,16 +7,16 @@ title: ScreenShareConversationNotificationErrorInfo
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **message** | **String** | | [optional] |
|
|
11
|
-
| **context_id** | **String** | | [optional] |
|
|
12
|
-
| **errors** | [**Array<ScreenShareConversationNotificationErrorBody>**](ScreenShareConversationNotificationErrorBody.html) | | [optional] |
|
|
13
|
-
| **message_params** | **Hash<String, String>** | | [optional] |
|
|
14
|
-
| **details** | [**Array<CallbackConversationNotificationErrorInfoDetails>**](CallbackConversationNotificationErrorInfoDetails.html) | | [optional] |
|
|
15
|
-
| **status** | **Integer** | | [optional] |
|
|
16
10
|
| **message_with_params** | **String** | | [optional] |
|
|
17
|
-
| **entity_id** | **String** | | [optional] |
|
|
18
11
|
| **code** | **String** | | [optional] |
|
|
19
12
|
| **entity_name** | **String** | | [optional] |
|
|
13
|
+
| **entity_id** | **String** | | [optional] |
|
|
14
|
+
| **context_id** | **String** | | [optional] |
|
|
15
|
+
| **details** | [**Array<CallbackConversationNotificationErrorInfoDetails>**](CallbackConversationNotificationErrorInfoDetails.html) | | [optional] |
|
|
16
|
+
| **message_params** | **Hash<String, String>** | | [optional] |
|
|
17
|
+
| **message** | **String** | | [optional] |
|
|
18
|
+
| **errors** | [**Array<ScreenShareConversationNotificationErrorBody>**](ScreenShareConversationNotificationErrorBody.html) | | [optional] |
|
|
19
|
+
| **status** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
22
22
|
|
|
@@ -7,33 +7,34 @@ title: ScreenShareConversationNotificationParticipants
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **queue** | [**ScreenShareConversationNotificationUriReference**](ScreenShareConversationNotificationUriReference.html) | | [optional] |
|
|
11
|
-
| **error_info** | [**ScreenShareConversationNotificationErrorInfo**](ScreenShareConversationNotificationErrorInfo.html) | | [optional] |
|
|
12
|
-
| **connected_time** | **DateTime** | | [optional] |
|
|
13
|
-
| **direction** | **String** | | [optional] |
|
|
14
10
|
| **wrapup_skipped** | **BOOLEAN** | | [optional] |
|
|
15
11
|
| **peer_count** | **Integer** | | [optional] |
|
|
16
|
-
| **state** | **String** | | [optional] |
|
|
17
12
|
| **purpose** | **String** | | [optional] |
|
|
18
|
-
| **
|
|
13
|
+
| **held** | **BOOLEAN** | | [optional] |
|
|
14
|
+
| **wrapup_timeout_ms** | **Integer** | | [optional] |
|
|
15
|
+
| **error_info** | [**ScreenShareConversationNotificationErrorInfo**](ScreenShareConversationNotificationErrorInfo.html) | | [optional] |
|
|
16
|
+
| **provider** | **String** | | [optional] |
|
|
17
|
+
| **wrapup_required** | **BOOLEAN** | | [optional] |
|
|
18
|
+
| **context** | **String** | | [optional] |
|
|
19
|
+
| **connected_time** | **DateTime** | | [optional] |
|
|
20
|
+
| **disconnect_type** | **String** | | [optional] |
|
|
19
21
|
| **start_time** | **DateTime** | | [optional] |
|
|
20
22
|
| **id** | **String** | | [optional] |
|
|
23
|
+
| **state** | **String** | | [optional] |
|
|
24
|
+
| **direction** | **String** | | [optional] |
|
|
25
|
+
| **wrapup** | [**ConversationNotificationWrapup**](ConversationNotificationWrapup.html) | | [optional] |
|
|
26
|
+
| **address** | **String** | | [optional] |
|
|
27
|
+
| **external_contact** | [**ScreenShareConversationNotificationUriReference**](ScreenShareConversationNotificationUriReference.html) | | [optional] |
|
|
21
28
|
| **sharing** | **BOOLEAN** | | [optional] |
|
|
22
|
-
| **wrapup_prompt** | **String** | | [optional] |
|
|
23
|
-
| **name** | **String** | | [optional] |
|
|
24
|
-
| **wrapup_timeout_ms** | **Integer** | | [optional] |
|
|
25
29
|
| **external_organization** | [**ScreenShareConversationNotificationUriReference**](ScreenShareConversationNotificationUriReference.html) | | [optional] |
|
|
26
|
-
| **held** | **BOOLEAN** | | [optional] |
|
|
27
|
-
| **wrapup_required** | **BOOLEAN** | | [optional] |
|
|
28
|
-
| **external_contact** | [**ScreenShareConversationNotificationUriReference**](ScreenShareConversationNotificationUriReference.html) | | [optional] |
|
|
29
|
-
| **provider** | **String** | | [optional] |
|
|
30
30
|
| **script** | [**ScreenShareConversationNotificationUriReference**](ScreenShareConversationNotificationUriReference.html) | | [optional] |
|
|
31
|
-
| **
|
|
32
|
-
| **
|
|
33
|
-
| **context** | **String** | | [optional] |
|
|
34
|
-
| **start_hold_time** | **DateTime** | | [optional] |
|
|
31
|
+
| **name** | **String** | | [optional] |
|
|
32
|
+
| **wrapup_prompt** | **String** | | [optional] |
|
|
35
33
|
| **attributes** | **Hash<String, String>** | | [optional] |
|
|
34
|
+
| **end_time** | **DateTime** | | [optional] |
|
|
35
|
+
| **start_hold_time** | **DateTime** | | [optional] |
|
|
36
36
|
| **user** | [**DocumentDataV2NotificationCreatedBy**](DocumentDataV2NotificationCreatedBy.html) | | [optional] |
|
|
37
|
+
| **queue** | [**ScreenShareConversationNotificationUriReference**](ScreenShareConversationNotificationUriReference.html) | | [optional] |
|
|
37
38
|
{: class="table table-striped"}
|
|
38
39
|
|
|
39
40
|
|
|
@@ -31,6 +31,7 @@ title: ScreenShareConversationNotificationScreenShareMediaParticipant
|
|
|
31
31
|
| **provider** | **String** | | [optional] |
|
|
32
32
|
| **external_contact** | [**ScreenShareConversationNotificationUriReference**](ScreenShareConversationNotificationUriReference.html) | | [optional] |
|
|
33
33
|
| **external_organization** | [**ScreenShareConversationNotificationUriReference**](ScreenShareConversationNotificationUriReference.html) | | [optional] |
|
|
34
|
+
| **wrapup** | [**ConversationNotificationWrapup**](ConversationNotificationWrapup.html) | | [optional] |
|
|
34
35
|
| **context** | **String** | | [optional] |
|
|
35
36
|
| **peer_count** | **Integer** | | [optional] |
|
|
36
37
|
| **sharing** | **BOOLEAN** | | [optional] |
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ScreenShareConversationNotificationWrapup
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::ScreenShareConversationNotificationWrapup
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **code** | **String** | | [optional] |
|
|
11
|
+
| **notes** | **String** | | [optional] |
|
|
12
|
+
| **tags** | **Array<String>** | | [optional] |
|
|
13
|
+
| **duration_seconds** | **Integer** | | [optional] |
|
|
14
|
+
| **end_time** | **DateTime** | | [optional] |
|
|
15
|
+
| **additional_properties** | **Object** | | [optional] |
|
|
16
|
+
{: class="table table-striped"}
|
|
17
|
+
|
|
18
|
+
|
|
@@ -11,11 +11,11 @@ title: ScriptEntityListing
|
|
|
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/ScriptsApi.html.md
CHANGED
|
@@ -271,7 +271,7 @@ Name | Type | Description | Notes
|
|
|
271
271
|
|
|
272
272
|
<a name="get_published_script_id_variables"></a>
|
|
273
273
|
|
|
274
|
-
## -Object** get_published_script_id_variables(script_id)
|
|
274
|
+
## -Object** get_published_script_id_variables(script_id, opts)
|
|
275
275
|
|
|
276
276
|
Get the published variables
|
|
277
277
|
|
|
@@ -299,10 +299,15 @@ api_instance = PureCloud::ScriptsApi.new
|
|
|
299
299
|
|
|
300
300
|
script_id = "script_id_example" # String | Script ID
|
|
301
301
|
|
|
302
|
+
opts = {
|
|
303
|
+
input: "input_example", # String | input
|
|
304
|
+
output: "output_example", # String | output
|
|
305
|
+
type: "type_example" # String | type
|
|
306
|
+
}
|
|
302
307
|
|
|
303
308
|
begin
|
|
304
309
|
#Get the published variables
|
|
305
|
-
result = api_instance.get_published_script_id_variables(script_id)
|
|
310
|
+
result = api_instance.get_published_script_id_variables(script_id, opts)
|
|
306
311
|
p result
|
|
307
312
|
rescue PureCloud::ApiError => e
|
|
308
313
|
puts "Exception when calling ScriptsApi->get_published_script_id_variables: #{e}"
|
|
@@ -314,6 +319,9 @@ end
|
|
|
314
319
|
Name | Type | Description | Notes
|
|
315
320
|
------------- | ------------- | ------------- | -------------
|
|
316
321
|
**script_id** | **String**| Script ID |
|
|
322
|
+
**input** | **String**| input | [optional]
|
|
323
|
+
**output** | **String**| output | [optional]
|
|
324
|
+
**type** | **String**| type | [optional]
|
|
317
325
|
{: class="table table-striped"}
|
|
318
326
|
|
|
319
327
|
|
data/doc_out/SearchApi.html.md
CHANGED
|
@@ -8,23 +8,84 @@ All URIs are relative to *https://api.mypurecloud.com*
|
|
|
8
8
|
|
|
9
9
|
Method | Description
|
|
10
10
|
------------- | ------------- | -------------
|
|
11
|
-
[**get_search**](SearchApi.html#get_search) | Search
|
|
12
|
-
[**get_search_0**](SearchApi.html#get_search_0) | Search
|
|
13
|
-
[**get_search_1**](SearchApi.html#get_search_1) | Search using the q64 value returned from a previous search
|
|
14
|
-
[**get_search_2**](SearchApi.html#get_search_2) | Search
|
|
15
|
-
[**get_search_3**](SearchApi.html#get_search_3) | Search
|
|
11
|
+
[**get_search**](SearchApi.html#get_search) | Search documentation using the q64 value returned from a previous search
|
|
12
|
+
[**get_search_0**](SearchApi.html#get_search_0) | Search groups using the q64 value returned from a previous search
|
|
13
|
+
[**get_search_1**](SearchApi.html#get_search_1) | Search locations using the q64 value returned from a previous search
|
|
14
|
+
[**get_search_2**](SearchApi.html#get_search_2) | Search using the q64 value returned from a previous search.
|
|
15
|
+
[**get_search_3**](SearchApi.html#get_search_3) | Search users using the q64 value returned from a previous search
|
|
16
|
+
[**get_search_4**](SearchApi.html#get_search_4) | Search voicemails using the q64 value returned from a previous search
|
|
16
17
|
[**get_suggest**](SearchApi.html#get_suggest) | Suggest resources using the q64 value returned from a previous suggest query.
|
|
17
|
-
[**post_search**](SearchApi.html#post_search) | Search
|
|
18
|
-
[**post_search_0**](SearchApi.html#post_search_0) | Search
|
|
19
|
-
[**post_search_1**](SearchApi.html#post_search_1) | Search
|
|
20
|
-
[**post_search_2**](SearchApi.html#post_search_2) | Search
|
|
21
|
-
[**post_search_3**](SearchApi.html#post_search_3) | Search
|
|
18
|
+
[**post_search**](SearchApi.html#post_search) | Search documentation
|
|
19
|
+
[**post_search_0**](SearchApi.html#post_search_0) | Search groups
|
|
20
|
+
[**post_search_1**](SearchApi.html#post_search_1) | Search locations
|
|
21
|
+
[**post_search_2**](SearchApi.html#post_search_2) | Search resources.
|
|
22
|
+
[**post_search_3**](SearchApi.html#post_search_3) | Search users
|
|
23
|
+
[**post_search_4**](SearchApi.html#post_search_4) | Search voicemails
|
|
22
24
|
[**post_suggest**](SearchApi.html#post_suggest) | Suggest resources.
|
|
23
25
|
{: class="table table-striped"}
|
|
24
26
|
|
|
25
27
|
<a name="get_search"></a>
|
|
26
28
|
|
|
27
|
-
## -[**
|
|
29
|
+
## -[**DocumentationSearchResponse**](DocumentationSearchResponse.html) get_search(q64)
|
|
30
|
+
|
|
31
|
+
Search documentation using the q64 value returned from a previous search
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
Wraps GET /api/v2/documentation/search
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
### Example
|
|
39
|
+
~~~ruby
|
|
40
|
+
# load the gem
|
|
41
|
+
require 'purecloud'
|
|
42
|
+
# setup authorization
|
|
43
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
44
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
45
|
+
environment = "mypurecloud.com"
|
|
46
|
+
|
|
47
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
48
|
+
|
|
49
|
+
PureCloud.configure do |config|
|
|
50
|
+
config.access_token = @authToken
|
|
51
|
+
end
|
|
52
|
+
|
|
53
|
+
api_instance = PureCloud::SearchApi.new
|
|
54
|
+
|
|
55
|
+
q64 = "q64_example" # String | q64
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
begin
|
|
59
|
+
#Search documentation using the q64 value returned from a previous search
|
|
60
|
+
result = api_instance.get_search(q64)
|
|
61
|
+
p result
|
|
62
|
+
rescue PureCloud::ApiError => e
|
|
63
|
+
puts "Exception when calling SearchApi->get_search: #{e}"
|
|
64
|
+
end
|
|
65
|
+
~~~
|
|
66
|
+
|
|
67
|
+
### Parameters
|
|
68
|
+
|
|
69
|
+
Name | Type | Description | Notes
|
|
70
|
+
------------- | ------------- | ------------- | -------------
|
|
71
|
+
**q64** | **String**| q64 |
|
|
72
|
+
{: class="table table-striped"}
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
### Return type
|
|
76
|
+
|
|
77
|
+
[**DocumentationSearchResponse**](DocumentationSearchResponse.html)
|
|
78
|
+
|
|
79
|
+
### HTTP request headers
|
|
80
|
+
|
|
81
|
+
- **Content-Type**: application/json
|
|
82
|
+
- **Accept**: application/json
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
<a name="get_search_0"></a>
|
|
87
|
+
|
|
88
|
+
## -[**GroupsSearchResponse**](GroupsSearchResponse.html) get_search_0(q64, opts)
|
|
28
89
|
|
|
29
90
|
Search groups using the q64 value returned from a previous search
|
|
30
91
|
|
|
@@ -58,10 +119,10 @@ opts = {
|
|
|
58
119
|
|
|
59
120
|
begin
|
|
60
121
|
#Search groups using the q64 value returned from a previous search
|
|
61
|
-
result = api_instance.
|
|
122
|
+
result = api_instance.get_search_0(q64, opts)
|
|
62
123
|
p result
|
|
63
124
|
rescue PureCloud::ApiError => e
|
|
64
|
-
puts "Exception when calling SearchApi->
|
|
125
|
+
puts "Exception when calling SearchApi->get_search_0: #{e}"
|
|
65
126
|
end
|
|
66
127
|
~~~
|
|
67
128
|
|
|
@@ -85,9 +146,9 @@ Name | Type | Description | Notes
|
|
|
85
146
|
|
|
86
147
|
|
|
87
148
|
|
|
88
|
-
<a name="
|
|
149
|
+
<a name="get_search_1"></a>
|
|
89
150
|
|
|
90
|
-
## -[**LocationsSearchResponse**](LocationsSearchResponse.html)
|
|
151
|
+
## -[**LocationsSearchResponse**](LocationsSearchResponse.html) get_search_1(q64, opts)
|
|
91
152
|
|
|
92
153
|
Search locations using the q64 value returned from a previous search
|
|
93
154
|
|
|
@@ -121,10 +182,10 @@ opts = {
|
|
|
121
182
|
|
|
122
183
|
begin
|
|
123
184
|
#Search locations using the q64 value returned from a previous search
|
|
124
|
-
result = api_instance.
|
|
185
|
+
result = api_instance.get_search_1(q64, opts)
|
|
125
186
|
p result
|
|
126
187
|
rescue PureCloud::ApiError => e
|
|
127
|
-
puts "Exception when calling SearchApi->
|
|
188
|
+
puts "Exception when calling SearchApi->get_search_1: #{e}"
|
|
128
189
|
end
|
|
129
190
|
~~~
|
|
130
191
|
|
|
@@ -148,9 +209,9 @@ Name | Type | Description | Notes
|
|
|
148
209
|
|
|
149
210
|
|
|
150
211
|
|
|
151
|
-
<a name="
|
|
212
|
+
<a name="get_search_2"></a>
|
|
152
213
|
|
|
153
|
-
## -[**JsonNodeSearchResponse**](JsonNodeSearchResponse.html)
|
|
214
|
+
## -[**JsonNodeSearchResponse**](JsonNodeSearchResponse.html) get_search_2(q64, opts)
|
|
154
215
|
|
|
155
216
|
Search using the q64 value returned from a previous search.
|
|
156
217
|
|
|
@@ -185,10 +246,10 @@ opts = {
|
|
|
185
246
|
|
|
186
247
|
begin
|
|
187
248
|
#Search using the q64 value returned from a previous search.
|
|
188
|
-
result = api_instance.
|
|
249
|
+
result = api_instance.get_search_2(q64, opts)
|
|
189
250
|
p result
|
|
190
251
|
rescue PureCloud::ApiError => e
|
|
191
|
-
puts "Exception when calling SearchApi->
|
|
252
|
+
puts "Exception when calling SearchApi->get_search_2: #{e}"
|
|
192
253
|
end
|
|
193
254
|
~~~
|
|
194
255
|
|
|
@@ -213,9 +274,9 @@ Name | Type | Description | Notes
|
|
|
213
274
|
|
|
214
275
|
|
|
215
276
|
|
|
216
|
-
<a name="
|
|
277
|
+
<a name="get_search_3"></a>
|
|
217
278
|
|
|
218
|
-
## -[**UsersSearchResponse**](UsersSearchResponse.html)
|
|
279
|
+
## -[**UsersSearchResponse**](UsersSearchResponse.html) get_search_3(q64, opts)
|
|
219
280
|
|
|
220
281
|
Search users using the q64 value returned from a previous search
|
|
221
282
|
|
|
@@ -249,10 +310,10 @@ opts = {
|
|
|
249
310
|
|
|
250
311
|
begin
|
|
251
312
|
#Search users using the q64 value returned from a previous search
|
|
252
|
-
result = api_instance.
|
|
313
|
+
result = api_instance.get_search_3(q64, opts)
|
|
253
314
|
p result
|
|
254
315
|
rescue PureCloud::ApiError => e
|
|
255
|
-
puts "Exception when calling SearchApi->
|
|
316
|
+
puts "Exception when calling SearchApi->get_search_3: #{e}"
|
|
256
317
|
end
|
|
257
318
|
~~~
|
|
258
319
|
|
|
@@ -276,9 +337,9 @@ Name | Type | Description | Notes
|
|
|
276
337
|
|
|
277
338
|
|
|
278
339
|
|
|
279
|
-
<a name="
|
|
340
|
+
<a name="get_search_4"></a>
|
|
280
341
|
|
|
281
|
-
## -[**VoicemailsSearchResponse**](VoicemailsSearchResponse.html)
|
|
342
|
+
## -[**VoicemailsSearchResponse**](VoicemailsSearchResponse.html) get_search_4(q64, opts)
|
|
282
343
|
|
|
283
344
|
Search voicemails using the q64 value returned from a previous search
|
|
284
345
|
|
|
@@ -312,10 +373,10 @@ opts = {
|
|
|
312
373
|
|
|
313
374
|
begin
|
|
314
375
|
#Search voicemails using the q64 value returned from a previous search
|
|
315
|
-
result = api_instance.
|
|
376
|
+
result = api_instance.get_search_4(q64, opts)
|
|
316
377
|
p result
|
|
317
378
|
rescue PureCloud::ApiError => e
|
|
318
|
-
puts "Exception when calling SearchApi->
|
|
379
|
+
puts "Exception when calling SearchApi->get_search_4: #{e}"
|
|
319
380
|
end
|
|
320
381
|
~~~
|
|
321
382
|
|
|
@@ -406,7 +467,66 @@ Name | Type | Description | Notes
|
|
|
406
467
|
|
|
407
468
|
<a name="post_search"></a>
|
|
408
469
|
|
|
409
|
-
## -[**
|
|
470
|
+
## -[**DocumentationSearchResponse**](DocumentationSearchResponse.html) post_search(body)
|
|
471
|
+
|
|
472
|
+
Search documentation
|
|
473
|
+
|
|
474
|
+
|
|
475
|
+
|
|
476
|
+
Wraps POST /api/v2/documentation/search
|
|
477
|
+
|
|
478
|
+
|
|
479
|
+
### Example
|
|
480
|
+
~~~ruby
|
|
481
|
+
# load the gem
|
|
482
|
+
require 'purecloud'
|
|
483
|
+
# setup authorization
|
|
484
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
485
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
486
|
+
environment = "mypurecloud.com"
|
|
487
|
+
|
|
488
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
489
|
+
|
|
490
|
+
PureCloud.configure do |config|
|
|
491
|
+
config.access_token = @authToken
|
|
492
|
+
end
|
|
493
|
+
|
|
494
|
+
api_instance = PureCloud::SearchApi.new
|
|
495
|
+
|
|
496
|
+
body = PureCloud::DocumentationSearchRequest.new # DocumentationSearchRequest | Search request options
|
|
497
|
+
|
|
498
|
+
|
|
499
|
+
begin
|
|
500
|
+
#Search documentation
|
|
501
|
+
result = api_instance.post_search(body)
|
|
502
|
+
p result
|
|
503
|
+
rescue PureCloud::ApiError => e
|
|
504
|
+
puts "Exception when calling SearchApi->post_search: #{e}"
|
|
505
|
+
end
|
|
506
|
+
~~~
|
|
507
|
+
|
|
508
|
+
### Parameters
|
|
509
|
+
|
|
510
|
+
Name | Type | Description | Notes
|
|
511
|
+
------------- | ------------- | ------------- | -------------
|
|
512
|
+
**body** | [**DocumentationSearchRequest**](DocumentationSearchRequest.html)| Search request options |
|
|
513
|
+
{: class="table table-striped"}
|
|
514
|
+
|
|
515
|
+
|
|
516
|
+
### Return type
|
|
517
|
+
|
|
518
|
+
[**DocumentationSearchResponse**](DocumentationSearchResponse.html)
|
|
519
|
+
|
|
520
|
+
### HTTP request headers
|
|
521
|
+
|
|
522
|
+
- **Content-Type**: application/json
|
|
523
|
+
- **Accept**: application/json
|
|
524
|
+
|
|
525
|
+
|
|
526
|
+
|
|
527
|
+
<a name="post_search_0"></a>
|
|
528
|
+
|
|
529
|
+
## -[**GroupsSearchResponse**](GroupsSearchResponse.html) post_search_0(body)
|
|
410
530
|
|
|
411
531
|
Search groups
|
|
412
532
|
|
|
@@ -437,10 +557,10 @@ body = PureCloud::GroupSearchRequest.new # GroupSearchRequest | Search request o
|
|
|
437
557
|
|
|
438
558
|
begin
|
|
439
559
|
#Search groups
|
|
440
|
-
result = api_instance.
|
|
560
|
+
result = api_instance.post_search_0(body)
|
|
441
561
|
p result
|
|
442
562
|
rescue PureCloud::ApiError => e
|
|
443
|
-
puts "Exception when calling SearchApi->
|
|
563
|
+
puts "Exception when calling SearchApi->post_search_0: #{e}"
|
|
444
564
|
end
|
|
445
565
|
~~~
|
|
446
566
|
|
|
@@ -463,9 +583,9 @@ Name | Type | Description | Notes
|
|
|
463
583
|
|
|
464
584
|
|
|
465
585
|
|
|
466
|
-
<a name="
|
|
586
|
+
<a name="post_search_1"></a>
|
|
467
587
|
|
|
468
|
-
## -[**LocationsSearchResponse**](LocationsSearchResponse.html)
|
|
588
|
+
## -[**LocationsSearchResponse**](LocationsSearchResponse.html) post_search_1(body)
|
|
469
589
|
|
|
470
590
|
Search locations
|
|
471
591
|
|
|
@@ -496,10 +616,10 @@ body = PureCloud::LocationSearchRequest.new # LocationSearchRequest | Search req
|
|
|
496
616
|
|
|
497
617
|
begin
|
|
498
618
|
#Search locations
|
|
499
|
-
result = api_instance.
|
|
619
|
+
result = api_instance.post_search_1(body)
|
|
500
620
|
p result
|
|
501
621
|
rescue PureCloud::ApiError => e
|
|
502
|
-
puts "Exception when calling SearchApi->
|
|
622
|
+
puts "Exception when calling SearchApi->post_search_1: #{e}"
|
|
503
623
|
end
|
|
504
624
|
~~~
|
|
505
625
|
|
|
@@ -522,9 +642,9 @@ Name | Type | Description | Notes
|
|
|
522
642
|
|
|
523
643
|
|
|
524
644
|
|
|
525
|
-
<a name="
|
|
645
|
+
<a name="post_search_2"></a>
|
|
526
646
|
|
|
527
|
-
## -[**JsonNodeSearchResponse**](JsonNodeSearchResponse.html)
|
|
647
|
+
## -[**JsonNodeSearchResponse**](JsonNodeSearchResponse.html) post_search_2(body, opts)
|
|
528
648
|
|
|
529
649
|
Search resources.
|
|
530
650
|
|
|
@@ -558,10 +678,10 @@ opts = {
|
|
|
558
678
|
|
|
559
679
|
begin
|
|
560
680
|
#Search resources.
|
|
561
|
-
result = api_instance.
|
|
681
|
+
result = api_instance.post_search_2(body, opts)
|
|
562
682
|
p result
|
|
563
683
|
rescue PureCloud::ApiError => e
|
|
564
|
-
puts "Exception when calling SearchApi->
|
|
684
|
+
puts "Exception when calling SearchApi->post_search_2: #{e}"
|
|
565
685
|
end
|
|
566
686
|
~~~
|
|
567
687
|
|
|
@@ -585,9 +705,9 @@ Name | Type | Description | Notes
|
|
|
585
705
|
|
|
586
706
|
|
|
587
707
|
|
|
588
|
-
<a name="
|
|
708
|
+
<a name="post_search_3"></a>
|
|
589
709
|
|
|
590
|
-
## -[**UsersSearchResponse**](UsersSearchResponse.html)
|
|
710
|
+
## -[**UsersSearchResponse**](UsersSearchResponse.html) post_search_3(body)
|
|
591
711
|
|
|
592
712
|
Search users
|
|
593
713
|
|
|
@@ -618,10 +738,10 @@ body = PureCloud::UserSearchRequest.new # UserSearchRequest | Search request opt
|
|
|
618
738
|
|
|
619
739
|
begin
|
|
620
740
|
#Search users
|
|
621
|
-
result = api_instance.
|
|
741
|
+
result = api_instance.post_search_3(body)
|
|
622
742
|
p result
|
|
623
743
|
rescue PureCloud::ApiError => e
|
|
624
|
-
puts "Exception when calling SearchApi->
|
|
744
|
+
puts "Exception when calling SearchApi->post_search_3: #{e}"
|
|
625
745
|
end
|
|
626
746
|
~~~
|
|
627
747
|
|
|
@@ -644,9 +764,9 @@ Name | Type | Description | Notes
|
|
|
644
764
|
|
|
645
765
|
|
|
646
766
|
|
|
647
|
-
<a name="
|
|
767
|
+
<a name="post_search_4"></a>
|
|
648
768
|
|
|
649
|
-
## -[**VoicemailsSearchResponse**](VoicemailsSearchResponse.html)
|
|
769
|
+
## -[**VoicemailsSearchResponse**](VoicemailsSearchResponse.html) post_search_4(body)
|
|
650
770
|
|
|
651
771
|
Search voicemails
|
|
652
772
|
|
|
@@ -677,10 +797,10 @@ body = PureCloud::VoicemailSearchRequest.new # VoicemailSearchRequest | Search r
|
|
|
677
797
|
|
|
678
798
|
begin
|
|
679
799
|
#Search voicemails
|
|
680
|
-
result = api_instance.
|
|
800
|
+
result = api_instance.post_search_4(body)
|
|
681
801
|
p result
|
|
682
802
|
rescue PureCloud::ApiError => e
|
|
683
|
-
puts "Exception when calling SearchApi->
|
|
803
|
+
puts "Exception when calling SearchApi->post_search_4: #{e}"
|
|
684
804
|
end
|
|
685
805
|
~~~
|
|
686
806
|
|