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: EvaluatorActivityEntityListing
|
|
|
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: ExtensionEntityListing
|
|
|
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: ExtensionPoolEntityListing
|
|
|
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,8 +7,8 @@ title: FaxDataV2NotificationLockInfo
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **locked_by** | [**FaxDataV2NotificationUserData**](FaxDataV2NotificationUserData.html) | | [optional] |
|
|
11
10
|
| **date_created** | **DateTime** | | [optional] |
|
|
11
|
+
| **locked_by** | [**FaxDataV2NotificationUserData**](FaxDataV2NotificationUserData.html) | | [optional] |
|
|
12
12
|
| **date_expires** | **DateTime** | | [optional] |
|
|
13
13
|
{: class="table table-striped"}
|
|
14
14
|
|
|
@@ -11,11 +11,11 @@ title: FaxDocumentEntityListing
|
|
|
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
|
|
|
@@ -1,14 +1,13 @@
|
|
|
1
1
|
---
|
|
2
|
-
title:
|
|
2
|
+
title: FeatureState
|
|
3
3
|
---
|
|
4
|
-
## PureCloud::
|
|
4
|
+
## PureCloud::FeatureState
|
|
5
5
|
|
|
6
6
|
## Properties
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **
|
|
11
|
-
| **key** | **String** | | [optional] |
|
|
10
|
+
| **enabled** | **BOOLEAN** | | [optional] |
|
|
12
11
|
{: class="table table-striped"}
|
|
13
12
|
|
|
14
13
|
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: GSuite
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::GSuite
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
|
+
| **name** | **String** | | [optional] |
|
|
12
|
+
| **relying_party_identifier** | **String** | | [optional] |
|
|
13
|
+
| **certificate** | **String** | | [optional] |
|
|
14
|
+
| **issuer_uri** | **String** | | [optional] |
|
|
15
|
+
| **sso_target_uri** | **String** | | [optional] |
|
|
16
|
+
| **disabled** | **BOOLEAN** | | [optional] |
|
|
17
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
18
|
+
{: class="table table-striped"}
|
|
19
|
+
|
|
20
|
+
|
data/doc_out/Geolocation.html.md
CHANGED
|
@@ -16,6 +16,7 @@ title: Geolocation
|
|
|
16
16
|
| **country** | **String** | | [optional] |
|
|
17
17
|
| **region** | **String** | | [optional] |
|
|
18
18
|
| **city** | **String** | | [optional] |
|
|
19
|
+
| **locations** | [**Array<LocationDefinition>**](LocationDefinition.html) | | [optional] |
|
|
19
20
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
20
21
|
{: class="table table-striped"}
|
|
21
22
|
|
|
@@ -11,11 +11,11 @@ title: GreetingListing
|
|
|
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
|
|
|
@@ -28,7 +28,7 @@ Method | Description
|
|
|
28
28
|
|
|
29
29
|
<a name="delete_greeting_id"></a>
|
|
30
30
|
|
|
31
|
-
## -
|
|
31
|
+
## - delete_greeting_id(greeting_id)
|
|
32
32
|
|
|
33
33
|
Deletes a Greeting with the given GreetingId
|
|
34
34
|
|
|
@@ -59,8 +59,7 @@ greeting_id = "greeting_id_example" # String | Greeting ID
|
|
|
59
59
|
|
|
60
60
|
begin
|
|
61
61
|
#Deletes a Greeting with the given GreetingId
|
|
62
|
-
|
|
63
|
-
p result
|
|
62
|
+
api_instance.delete_greeting_id(greeting_id)
|
|
64
63
|
rescue PureCloud::ApiError => e
|
|
65
64
|
puts "Exception when calling GreetingsApi->delete_greeting_id: #{e}"
|
|
66
65
|
end
|
|
@@ -76,7 +75,7 @@ Name | Type | Description | Notes
|
|
|
76
75
|
|
|
77
76
|
### Return type
|
|
78
77
|
|
|
79
|
-
|
|
78
|
+
nil (empty response body)
|
|
80
79
|
|
|
81
80
|
### HTTP request headers
|
|
82
81
|
|
|
@@ -11,11 +11,11 @@ title: GroupEntityListing
|
|
|
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,8 +11,6 @@ title: GroupSearchRequest
|
|
|
11
11
|
| **sort_by** | **String** | The field in the resource that you want to sort the results by | [optional] |
|
|
12
12
|
| **page_size** | **Integer** | The number of results per page | [optional] |
|
|
13
13
|
| **page_number** | **Integer** | The page of resources you want to retrieve | [optional] |
|
|
14
|
-
| **return_fields** | **Array<String>** | A List of strings containing the resource field paths that you want to return | [optional] |
|
|
15
|
-
| **expand** | **Array<String>** | Provides more details about a specified resource | [optional] |
|
|
16
14
|
| **query** | [**Array<GroupSearchCriteria>**](GroupSearchCriteria.html) | | [optional] |
|
|
17
15
|
{: class="table table-striped"}
|
|
18
16
|
|
data/doc_out/GroupsApi.html.md
CHANGED
|
@@ -23,7 +23,7 @@ Method | Description
|
|
|
23
23
|
|
|
24
24
|
<a name="delete_group_id"></a>
|
|
25
25
|
|
|
26
|
-
## -
|
|
26
|
+
## - delete_group_id(group_id)
|
|
27
27
|
|
|
28
28
|
Delete group
|
|
29
29
|
|
|
@@ -54,8 +54,7 @@ group_id = "group_id_example" # String | Group ID
|
|
|
54
54
|
|
|
55
55
|
begin
|
|
56
56
|
#Delete group
|
|
57
|
-
|
|
58
|
-
p result
|
|
57
|
+
api_instance.delete_group_id(group_id)
|
|
59
58
|
rescue PureCloud::ApiError => e
|
|
60
59
|
puts "Exception when calling GroupsApi->delete_group_id: #{e}"
|
|
61
60
|
end
|
|
@@ -71,7 +70,7 @@ Name | Type | Description | Notes
|
|
|
71
70
|
|
|
72
71
|
### Return type
|
|
73
72
|
|
|
74
|
-
|
|
73
|
+
nil (empty response body)
|
|
75
74
|
|
|
76
75
|
### HTTP request headers
|
|
77
76
|
|
|
@@ -11,11 +11,11 @@ title: HeartBeatAlertContainer
|
|
|
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,8 +7,8 @@ title: HeartBeatAlertNotificationNotificationUsers
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **id** | **String** | | [optional] |
|
|
11
10
|
| **display_name** | **String** | | [optional] |
|
|
11
|
+
| **id** | **String** | | [optional] |
|
|
12
12
|
{: class="table table-striped"}
|
|
13
13
|
|
|
14
14
|
|
|
@@ -11,11 +11,11 @@ title: HeartBeatRuleContainer
|
|
|
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
|
|
|
@@ -10,31 +10,34 @@ Method | Description
|
|
|
10
10
|
------------- | ------------- | -------------
|
|
11
11
|
[**delete_adfs**](IdentityProviderApi.html#delete_adfs) | Delete ADFS Identity Provider
|
|
12
12
|
[**delete_cic**](IdentityProviderApi.html#delete_cic) | Delete Customer Interaction Center (CIC) Identity Provider
|
|
13
|
+
[**delete_gsuite**](IdentityProviderApi.html#delete_gsuite) | Delete G Suite Identity Provider
|
|
13
14
|
[**delete_okta**](IdentityProviderApi.html#delete_okta) | Delete Okta Identity Provider
|
|
14
15
|
[**delete_onelogin**](IdentityProviderApi.html#delete_onelogin) | Delete OneLogin Identity Provider
|
|
15
|
-
[**
|
|
16
|
+
[**delete_ping**](IdentityProviderApi.html#delete_ping) | Delete Ping Identity Provider
|
|
16
17
|
[**delete_purecloud**](IdentityProviderApi.html#delete_purecloud) | Delete PureCloud Identity Provider
|
|
17
18
|
[**delete_salesforce**](IdentityProviderApi.html#delete_salesforce) | Delete Salesforce Identity Provider
|
|
18
19
|
[**get_adfs**](IdentityProviderApi.html#get_adfs) | Get ADFS Identity Provider
|
|
19
20
|
[**get_cic**](IdentityProviderApi.html#get_cic) | Get Customer Interaction Center (CIC) Identity Provider
|
|
21
|
+
[**get_gsuite**](IdentityProviderApi.html#get_gsuite) | Get G Suite Identity Provider
|
|
20
22
|
[**get_identityproviders**](IdentityProviderApi.html#get_identityproviders) | The list of identity providers
|
|
21
23
|
[**get_okta**](IdentityProviderApi.html#get_okta) | Get Okta Identity Provider
|
|
22
24
|
[**get_onelogin**](IdentityProviderApi.html#get_onelogin) | Get OneLogin Identity Provider
|
|
23
|
-
[**
|
|
25
|
+
[**get_ping**](IdentityProviderApi.html#get_ping) | Get Ping Identity Provider
|
|
24
26
|
[**get_purecloud**](IdentityProviderApi.html#get_purecloud) | Get PureCloud Identity Provider
|
|
25
27
|
[**get_salesforce**](IdentityProviderApi.html#get_salesforce) | Get Salesforce Identity Provider
|
|
26
28
|
[**put_adfs**](IdentityProviderApi.html#put_adfs) | Update/Create ADFS Identity Provider
|
|
27
29
|
[**put_cic**](IdentityProviderApi.html#put_cic) | Update/Create Customer Interaction Center (CIC) Identity Provider
|
|
30
|
+
[**put_gsuite**](IdentityProviderApi.html#put_gsuite) | Update/Create G Suite Identity Provider
|
|
28
31
|
[**put_okta**](IdentityProviderApi.html#put_okta) | Update/Create Okta Identity Provider
|
|
29
32
|
[**put_onelogin**](IdentityProviderApi.html#put_onelogin) | Update/Create OneLogin Identity Provider
|
|
30
|
-
[**
|
|
33
|
+
[**put_ping**](IdentityProviderApi.html#put_ping) | Update/Create Ping Identity Provider
|
|
31
34
|
[**put_purecloud**](IdentityProviderApi.html#put_purecloud) | Update/Create PureCloud Identity Provider
|
|
32
35
|
[**put_salesforce**](IdentityProviderApi.html#put_salesforce) | Update/Create Salesforce Identity Provider
|
|
33
36
|
{: class="table table-striped"}
|
|
34
37
|
|
|
35
38
|
<a name="delete_adfs"></a>
|
|
36
39
|
|
|
37
|
-
## - delete_adfs
|
|
40
|
+
## -[**Empty**](Empty.html) delete_adfs
|
|
38
41
|
|
|
39
42
|
Delete ADFS Identity Provider
|
|
40
43
|
|
|
@@ -62,7 +65,8 @@ api_instance = PureCloud::IdentityProviderApi.new
|
|
|
62
65
|
|
|
63
66
|
begin
|
|
64
67
|
#Delete ADFS Identity Provider
|
|
65
|
-
api_instance.delete_adfs
|
|
68
|
+
result = api_instance.delete_adfs
|
|
69
|
+
p result
|
|
66
70
|
rescue PureCloud::ApiError => e
|
|
67
71
|
puts "Exception when calling IdentityProviderApi->delete_adfs: #{e}"
|
|
68
72
|
end
|
|
@@ -75,7 +79,7 @@ This endpoint does not need any parameter.
|
|
|
75
79
|
|
|
76
80
|
### Return type
|
|
77
81
|
|
|
78
|
-
|
|
82
|
+
[**Empty**](Empty.html)
|
|
79
83
|
|
|
80
84
|
### HTTP request headers
|
|
81
85
|
|
|
@@ -86,7 +90,7 @@ nil (empty response body)
|
|
|
86
90
|
|
|
87
91
|
<a name="delete_cic"></a>
|
|
88
92
|
|
|
89
|
-
## - delete_cic
|
|
93
|
+
## -[**Empty**](Empty.html) delete_cic
|
|
90
94
|
|
|
91
95
|
Delete Customer Interaction Center (CIC) Identity Provider
|
|
92
96
|
|
|
@@ -114,7 +118,8 @@ api_instance = PureCloud::IdentityProviderApi.new
|
|
|
114
118
|
|
|
115
119
|
begin
|
|
116
120
|
#Delete Customer Interaction Center (CIC) Identity Provider
|
|
117
|
-
api_instance.delete_cic
|
|
121
|
+
result = api_instance.delete_cic
|
|
122
|
+
p result
|
|
118
123
|
rescue PureCloud::ApiError => e
|
|
119
124
|
puts "Exception when calling IdentityProviderApi->delete_cic: #{e}"
|
|
120
125
|
end
|
|
@@ -127,7 +132,60 @@ This endpoint does not need any parameter.
|
|
|
127
132
|
|
|
128
133
|
### Return type
|
|
129
134
|
|
|
130
|
-
|
|
135
|
+
[**Empty**](Empty.html)
|
|
136
|
+
|
|
137
|
+
### HTTP request headers
|
|
138
|
+
|
|
139
|
+
- **Content-Type**: application/json
|
|
140
|
+
- **Accept**: application/json
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
<a name="delete_gsuite"></a>
|
|
145
|
+
|
|
146
|
+
## -[**Empty**](Empty.html) delete_gsuite
|
|
147
|
+
|
|
148
|
+
Delete G Suite Identity Provider
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
Wraps DELETE /api/v2/identityproviders/gsuite
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
### Example
|
|
156
|
+
~~~ruby
|
|
157
|
+
# load the gem
|
|
158
|
+
require 'purecloud'
|
|
159
|
+
# setup authorization
|
|
160
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
161
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
162
|
+
environment = "mypurecloud.com"
|
|
163
|
+
|
|
164
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
165
|
+
|
|
166
|
+
PureCloud.configure do |config|
|
|
167
|
+
config.access_token = @authToken
|
|
168
|
+
end
|
|
169
|
+
|
|
170
|
+
api_instance = PureCloud::IdentityProviderApi.new
|
|
171
|
+
|
|
172
|
+
begin
|
|
173
|
+
#Delete G Suite Identity Provider
|
|
174
|
+
result = api_instance.delete_gsuite
|
|
175
|
+
p result
|
|
176
|
+
rescue PureCloud::ApiError => e
|
|
177
|
+
puts "Exception when calling IdentityProviderApi->delete_gsuite: #{e}"
|
|
178
|
+
end
|
|
179
|
+
~~~
|
|
180
|
+
|
|
181
|
+
### Parameters
|
|
182
|
+
This endpoint does not need any parameter.
|
|
183
|
+
{: class="table table-striped"}
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
### Return type
|
|
187
|
+
|
|
188
|
+
[**Empty**](Empty.html)
|
|
131
189
|
|
|
132
190
|
### HTTP request headers
|
|
133
191
|
|
|
@@ -138,7 +196,7 @@ nil (empty response body)
|
|
|
138
196
|
|
|
139
197
|
<a name="delete_okta"></a>
|
|
140
198
|
|
|
141
|
-
## - delete_okta
|
|
199
|
+
## -[**Empty**](Empty.html) delete_okta
|
|
142
200
|
|
|
143
201
|
Delete Okta Identity Provider
|
|
144
202
|
|
|
@@ -166,7 +224,8 @@ api_instance = PureCloud::IdentityProviderApi.new
|
|
|
166
224
|
|
|
167
225
|
begin
|
|
168
226
|
#Delete Okta Identity Provider
|
|
169
|
-
api_instance.delete_okta
|
|
227
|
+
result = api_instance.delete_okta
|
|
228
|
+
p result
|
|
170
229
|
rescue PureCloud::ApiError => e
|
|
171
230
|
puts "Exception when calling IdentityProviderApi->delete_okta: #{e}"
|
|
172
231
|
end
|
|
@@ -179,7 +238,7 @@ This endpoint does not need any parameter.
|
|
|
179
238
|
|
|
180
239
|
### Return type
|
|
181
240
|
|
|
182
|
-
|
|
241
|
+
[**Empty**](Empty.html)
|
|
183
242
|
|
|
184
243
|
### HTTP request headers
|
|
185
244
|
|
|
@@ -190,7 +249,7 @@ nil (empty response body)
|
|
|
190
249
|
|
|
191
250
|
<a name="delete_onelogin"></a>
|
|
192
251
|
|
|
193
|
-
## - delete_onelogin
|
|
252
|
+
## -[**Empty**](Empty.html) delete_onelogin
|
|
194
253
|
|
|
195
254
|
Delete OneLogin Identity Provider
|
|
196
255
|
|
|
@@ -218,7 +277,8 @@ api_instance = PureCloud::IdentityProviderApi.new
|
|
|
218
277
|
|
|
219
278
|
begin
|
|
220
279
|
#Delete OneLogin Identity Provider
|
|
221
|
-
api_instance.delete_onelogin
|
|
280
|
+
result = api_instance.delete_onelogin
|
|
281
|
+
p result
|
|
222
282
|
rescue PureCloud::ApiError => e
|
|
223
283
|
puts "Exception when calling IdentityProviderApi->delete_onelogin: #{e}"
|
|
224
284
|
end
|
|
@@ -231,7 +291,7 @@ This endpoint does not need any parameter.
|
|
|
231
291
|
|
|
232
292
|
### Return type
|
|
233
293
|
|
|
234
|
-
|
|
294
|
+
[**Empty**](Empty.html)
|
|
235
295
|
|
|
236
296
|
### HTTP request headers
|
|
237
297
|
|
|
@@ -240,15 +300,15 @@ nil (empty response body)
|
|
|
240
300
|
|
|
241
301
|
|
|
242
302
|
|
|
243
|
-
<a name="
|
|
303
|
+
<a name="delete_ping"></a>
|
|
244
304
|
|
|
245
|
-
## -
|
|
305
|
+
## -[**Empty**](Empty.html) delete_ping
|
|
246
306
|
|
|
247
|
-
Delete
|
|
307
|
+
Delete Ping Identity Provider
|
|
248
308
|
|
|
249
309
|
|
|
250
310
|
|
|
251
|
-
Wraps DELETE /api/v2/identityproviders/
|
|
311
|
+
Wraps DELETE /api/v2/identityproviders/ping
|
|
252
312
|
|
|
253
313
|
|
|
254
314
|
### Example
|
|
@@ -269,10 +329,11 @@ end
|
|
|
269
329
|
api_instance = PureCloud::IdentityProviderApi.new
|
|
270
330
|
|
|
271
331
|
begin
|
|
272
|
-
#Delete
|
|
273
|
-
api_instance.
|
|
332
|
+
#Delete Ping Identity Provider
|
|
333
|
+
result = api_instance.delete_ping
|
|
334
|
+
p result
|
|
274
335
|
rescue PureCloud::ApiError => e
|
|
275
|
-
puts "Exception when calling IdentityProviderApi->
|
|
336
|
+
puts "Exception when calling IdentityProviderApi->delete_ping: #{e}"
|
|
276
337
|
end
|
|
277
338
|
~~~
|
|
278
339
|
|
|
@@ -283,7 +344,7 @@ This endpoint does not need any parameter.
|
|
|
283
344
|
|
|
284
345
|
### Return type
|
|
285
346
|
|
|
286
|
-
|
|
347
|
+
[**Empty**](Empty.html)
|
|
287
348
|
|
|
288
349
|
### HTTP request headers
|
|
289
350
|
|
|
@@ -294,7 +355,7 @@ nil (empty response body)
|
|
|
294
355
|
|
|
295
356
|
<a name="delete_purecloud"></a>
|
|
296
357
|
|
|
297
|
-
## - delete_purecloud
|
|
358
|
+
## -[**Empty**](Empty.html) delete_purecloud
|
|
298
359
|
|
|
299
360
|
Delete PureCloud Identity Provider
|
|
300
361
|
|
|
@@ -322,7 +383,8 @@ api_instance = PureCloud::IdentityProviderApi.new
|
|
|
322
383
|
|
|
323
384
|
begin
|
|
324
385
|
#Delete PureCloud Identity Provider
|
|
325
|
-
api_instance.delete_purecloud
|
|
386
|
+
result = api_instance.delete_purecloud
|
|
387
|
+
p result
|
|
326
388
|
rescue PureCloud::ApiError => e
|
|
327
389
|
puts "Exception when calling IdentityProviderApi->delete_purecloud: #{e}"
|
|
328
390
|
end
|
|
@@ -335,7 +397,7 @@ This endpoint does not need any parameter.
|
|
|
335
397
|
|
|
336
398
|
### Return type
|
|
337
399
|
|
|
338
|
-
|
|
400
|
+
[**Empty**](Empty.html)
|
|
339
401
|
|
|
340
402
|
### HTTP request headers
|
|
341
403
|
|
|
@@ -346,7 +408,7 @@ nil (empty response body)
|
|
|
346
408
|
|
|
347
409
|
<a name="delete_salesforce"></a>
|
|
348
410
|
|
|
349
|
-
## - delete_salesforce
|
|
411
|
+
## -[**Empty**](Empty.html) delete_salesforce
|
|
350
412
|
|
|
351
413
|
Delete Salesforce Identity Provider
|
|
352
414
|
|
|
@@ -374,7 +436,8 @@ api_instance = PureCloud::IdentityProviderApi.new
|
|
|
374
436
|
|
|
375
437
|
begin
|
|
376
438
|
#Delete Salesforce Identity Provider
|
|
377
|
-
api_instance.delete_salesforce
|
|
439
|
+
result = api_instance.delete_salesforce
|
|
440
|
+
p result
|
|
378
441
|
rescue PureCloud::ApiError => e
|
|
379
442
|
puts "Exception when calling IdentityProviderApi->delete_salesforce: #{e}"
|
|
380
443
|
end
|
|
@@ -387,7 +450,7 @@ This endpoint does not need any parameter.
|
|
|
387
450
|
|
|
388
451
|
### Return type
|
|
389
452
|
|
|
390
|
-
|
|
453
|
+
[**Empty**](Empty.html)
|
|
391
454
|
|
|
392
455
|
### HTTP request headers
|
|
393
456
|
|
|
@@ -502,6 +565,59 @@ This endpoint does not need any parameter.
|
|
|
502
565
|
|
|
503
566
|
|
|
504
567
|
|
|
568
|
+
<a name="get_gsuite"></a>
|
|
569
|
+
|
|
570
|
+
## -[**GSuite**](GSuite.html) get_gsuite
|
|
571
|
+
|
|
572
|
+
Get G Suite Identity Provider
|
|
573
|
+
|
|
574
|
+
|
|
575
|
+
|
|
576
|
+
Wraps GET /api/v2/identityproviders/gsuite
|
|
577
|
+
|
|
578
|
+
|
|
579
|
+
### Example
|
|
580
|
+
~~~ruby
|
|
581
|
+
# load the gem
|
|
582
|
+
require 'purecloud'
|
|
583
|
+
# setup authorization
|
|
584
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
585
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
586
|
+
environment = "mypurecloud.com"
|
|
587
|
+
|
|
588
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
589
|
+
|
|
590
|
+
PureCloud.configure do |config|
|
|
591
|
+
config.access_token = @authToken
|
|
592
|
+
end
|
|
593
|
+
|
|
594
|
+
api_instance = PureCloud::IdentityProviderApi.new
|
|
595
|
+
|
|
596
|
+
begin
|
|
597
|
+
#Get G Suite Identity Provider
|
|
598
|
+
result = api_instance.get_gsuite
|
|
599
|
+
p result
|
|
600
|
+
rescue PureCloud::ApiError => e
|
|
601
|
+
puts "Exception when calling IdentityProviderApi->get_gsuite: #{e}"
|
|
602
|
+
end
|
|
603
|
+
~~~
|
|
604
|
+
|
|
605
|
+
### Parameters
|
|
606
|
+
This endpoint does not need any parameter.
|
|
607
|
+
{: class="table table-striped"}
|
|
608
|
+
|
|
609
|
+
|
|
610
|
+
### Return type
|
|
611
|
+
|
|
612
|
+
[**GSuite**](GSuite.html)
|
|
613
|
+
|
|
614
|
+
### HTTP request headers
|
|
615
|
+
|
|
616
|
+
- **Content-Type**: application/json
|
|
617
|
+
- **Accept**: application/json
|
|
618
|
+
|
|
619
|
+
|
|
620
|
+
|
|
505
621
|
<a name="get_identityproviders"></a>
|
|
506
622
|
|
|
507
623
|
## -[**OAuthProviderEntityListing**](OAuthProviderEntityListing.html) get_identityproviders
|
|
@@ -661,15 +777,15 @@ This endpoint does not need any parameter.
|
|
|
661
777
|
|
|
662
778
|
|
|
663
779
|
|
|
664
|
-
<a name="
|
|
780
|
+
<a name="get_ping"></a>
|
|
665
781
|
|
|
666
|
-
## -[**
|
|
782
|
+
## -[**PingIdentity**](PingIdentity.html) get_ping
|
|
667
783
|
|
|
668
|
-
Get
|
|
784
|
+
Get Ping Identity Provider
|
|
669
785
|
|
|
670
786
|
|
|
671
787
|
|
|
672
|
-
Wraps GET /api/v2/identityproviders/
|
|
788
|
+
Wraps GET /api/v2/identityproviders/ping
|
|
673
789
|
|
|
674
790
|
|
|
675
791
|
### Example
|
|
@@ -690,11 +806,11 @@ end
|
|
|
690
806
|
api_instance = PureCloud::IdentityProviderApi.new
|
|
691
807
|
|
|
692
808
|
begin
|
|
693
|
-
#Get
|
|
694
|
-
result = api_instance.
|
|
809
|
+
#Get Ping Identity Provider
|
|
810
|
+
result = api_instance.get_ping
|
|
695
811
|
p result
|
|
696
812
|
rescue PureCloud::ApiError => e
|
|
697
|
-
puts "Exception when calling IdentityProviderApi->
|
|
813
|
+
puts "Exception when calling IdentityProviderApi->get_ping: #{e}"
|
|
698
814
|
end
|
|
699
815
|
~~~
|
|
700
816
|
|
|
@@ -705,7 +821,7 @@ This endpoint does not need any parameter.
|
|
|
705
821
|
|
|
706
822
|
### Return type
|
|
707
823
|
|
|
708
|
-
[**
|
|
824
|
+
[**PingIdentity**](PingIdentity.html)
|
|
709
825
|
|
|
710
826
|
### HTTP request headers
|
|
711
827
|
|
|
@@ -822,7 +938,7 @@ This endpoint does not need any parameter.
|
|
|
822
938
|
|
|
823
939
|
<a name="put_adfs"></a>
|
|
824
940
|
|
|
825
|
-
## - put_adfs(body)
|
|
941
|
+
## -[**OAuthProvider**](OAuthProvider.html) put_adfs(body)
|
|
826
942
|
|
|
827
943
|
Update/Create ADFS Identity Provider
|
|
828
944
|
|
|
@@ -853,7 +969,8 @@ body = PureCloud::ADFS.new # ADFS | Provider
|
|
|
853
969
|
|
|
854
970
|
begin
|
|
855
971
|
#Update/Create ADFS Identity Provider
|
|
856
|
-
api_instance.put_adfs(body)
|
|
972
|
+
result = api_instance.put_adfs(body)
|
|
973
|
+
p result
|
|
857
974
|
rescue PureCloud::ApiError => e
|
|
858
975
|
puts "Exception when calling IdentityProviderApi->put_adfs: #{e}"
|
|
859
976
|
end
|
|
@@ -869,7 +986,7 @@ Name | Type | Description | Notes
|
|
|
869
986
|
|
|
870
987
|
### Return type
|
|
871
988
|
|
|
872
|
-
|
|
989
|
+
[**OAuthProvider**](OAuthProvider.html)
|
|
873
990
|
|
|
874
991
|
### HTTP request headers
|
|
875
992
|
|
|
@@ -880,7 +997,7 @@ nil (empty response body)
|
|
|
880
997
|
|
|
881
998
|
<a name="put_cic"></a>
|
|
882
999
|
|
|
883
|
-
## - put_cic(body)
|
|
1000
|
+
## -[**OAuthProvider**](OAuthProvider.html) put_cic(body)
|
|
884
1001
|
|
|
885
1002
|
Update/Create Customer Interaction Center (CIC) Identity Provider
|
|
886
1003
|
|
|
@@ -911,7 +1028,8 @@ body = PureCloud::CustomerInteractionCenter.new # CustomerInteractionCenter | Pr
|
|
|
911
1028
|
|
|
912
1029
|
begin
|
|
913
1030
|
#Update/Create Customer Interaction Center (CIC) Identity Provider
|
|
914
|
-
api_instance.put_cic(body)
|
|
1031
|
+
result = api_instance.put_cic(body)
|
|
1032
|
+
p result
|
|
915
1033
|
rescue PureCloud::ApiError => e
|
|
916
1034
|
puts "Exception when calling IdentityProviderApi->put_cic: #{e}"
|
|
917
1035
|
end
|
|
@@ -927,7 +1045,66 @@ Name | Type | Description | Notes
|
|
|
927
1045
|
|
|
928
1046
|
### Return type
|
|
929
1047
|
|
|
930
|
-
|
|
1048
|
+
[**OAuthProvider**](OAuthProvider.html)
|
|
1049
|
+
|
|
1050
|
+
### HTTP request headers
|
|
1051
|
+
|
|
1052
|
+
- **Content-Type**: application/json
|
|
1053
|
+
- **Accept**: application/json
|
|
1054
|
+
|
|
1055
|
+
|
|
1056
|
+
|
|
1057
|
+
<a name="put_gsuite"></a>
|
|
1058
|
+
|
|
1059
|
+
## -[**OAuthProvider**](OAuthProvider.html) put_gsuite(body)
|
|
1060
|
+
|
|
1061
|
+
Update/Create G Suite Identity Provider
|
|
1062
|
+
|
|
1063
|
+
|
|
1064
|
+
|
|
1065
|
+
Wraps PUT /api/v2/identityproviders/gsuite
|
|
1066
|
+
|
|
1067
|
+
|
|
1068
|
+
### Example
|
|
1069
|
+
~~~ruby
|
|
1070
|
+
# load the gem
|
|
1071
|
+
require 'purecloud'
|
|
1072
|
+
# setup authorization
|
|
1073
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1074
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1075
|
+
environment = "mypurecloud.com"
|
|
1076
|
+
|
|
1077
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1078
|
+
|
|
1079
|
+
PureCloud.configure do |config|
|
|
1080
|
+
config.access_token = @authToken
|
|
1081
|
+
end
|
|
1082
|
+
|
|
1083
|
+
api_instance = PureCloud::IdentityProviderApi.new
|
|
1084
|
+
|
|
1085
|
+
body = PureCloud::GSuite.new # GSuite | Provider
|
|
1086
|
+
|
|
1087
|
+
|
|
1088
|
+
begin
|
|
1089
|
+
#Update/Create G Suite Identity Provider
|
|
1090
|
+
result = api_instance.put_gsuite(body)
|
|
1091
|
+
p result
|
|
1092
|
+
rescue PureCloud::ApiError => e
|
|
1093
|
+
puts "Exception when calling IdentityProviderApi->put_gsuite: #{e}"
|
|
1094
|
+
end
|
|
1095
|
+
~~~
|
|
1096
|
+
|
|
1097
|
+
### Parameters
|
|
1098
|
+
|
|
1099
|
+
Name | Type | Description | Notes
|
|
1100
|
+
------------- | ------------- | ------------- | -------------
|
|
1101
|
+
**body** | [**GSuite**](GSuite.html)| Provider |
|
|
1102
|
+
{: class="table table-striped"}
|
|
1103
|
+
|
|
1104
|
+
|
|
1105
|
+
### Return type
|
|
1106
|
+
|
|
1107
|
+
[**OAuthProvider**](OAuthProvider.html)
|
|
931
1108
|
|
|
932
1109
|
### HTTP request headers
|
|
933
1110
|
|
|
@@ -938,7 +1115,7 @@ nil (empty response body)
|
|
|
938
1115
|
|
|
939
1116
|
<a name="put_okta"></a>
|
|
940
1117
|
|
|
941
|
-
## - put_okta(body)
|
|
1118
|
+
## -[**OAuthProvider**](OAuthProvider.html) put_okta(body)
|
|
942
1119
|
|
|
943
1120
|
Update/Create Okta Identity Provider
|
|
944
1121
|
|
|
@@ -969,7 +1146,8 @@ body = PureCloud::Okta.new # Okta | Provider
|
|
|
969
1146
|
|
|
970
1147
|
begin
|
|
971
1148
|
#Update/Create Okta Identity Provider
|
|
972
|
-
api_instance.put_okta(body)
|
|
1149
|
+
result = api_instance.put_okta(body)
|
|
1150
|
+
p result
|
|
973
1151
|
rescue PureCloud::ApiError => e
|
|
974
1152
|
puts "Exception when calling IdentityProviderApi->put_okta: #{e}"
|
|
975
1153
|
end
|
|
@@ -985,7 +1163,7 @@ Name | Type | Description | Notes
|
|
|
985
1163
|
|
|
986
1164
|
### Return type
|
|
987
1165
|
|
|
988
|
-
|
|
1166
|
+
[**OAuthProvider**](OAuthProvider.html)
|
|
989
1167
|
|
|
990
1168
|
### HTTP request headers
|
|
991
1169
|
|
|
@@ -996,7 +1174,7 @@ nil (empty response body)
|
|
|
996
1174
|
|
|
997
1175
|
<a name="put_onelogin"></a>
|
|
998
1176
|
|
|
999
|
-
## - put_onelogin(body)
|
|
1177
|
+
## -[**OAuthProvider**](OAuthProvider.html) put_onelogin(body)
|
|
1000
1178
|
|
|
1001
1179
|
Update/Create OneLogin Identity Provider
|
|
1002
1180
|
|
|
@@ -1027,7 +1205,8 @@ body = PureCloud::OneLogin.new # OneLogin | Provider
|
|
|
1027
1205
|
|
|
1028
1206
|
begin
|
|
1029
1207
|
#Update/Create OneLogin Identity Provider
|
|
1030
|
-
api_instance.put_onelogin(body)
|
|
1208
|
+
result = api_instance.put_onelogin(body)
|
|
1209
|
+
p result
|
|
1031
1210
|
rescue PureCloud::ApiError => e
|
|
1032
1211
|
puts "Exception when calling IdentityProviderApi->put_onelogin: #{e}"
|
|
1033
1212
|
end
|
|
@@ -1043,7 +1222,7 @@ Name | Type | Description | Notes
|
|
|
1043
1222
|
|
|
1044
1223
|
### Return type
|
|
1045
1224
|
|
|
1046
|
-
|
|
1225
|
+
[**OAuthProvider**](OAuthProvider.html)
|
|
1047
1226
|
|
|
1048
1227
|
### HTTP request headers
|
|
1049
1228
|
|
|
@@ -1052,15 +1231,15 @@ nil (empty response body)
|
|
|
1052
1231
|
|
|
1053
1232
|
|
|
1054
1233
|
|
|
1055
|
-
<a name="
|
|
1234
|
+
<a name="put_ping"></a>
|
|
1056
1235
|
|
|
1057
|
-
## -
|
|
1236
|
+
## -[**OAuthProvider**](OAuthProvider.html) put_ping(body)
|
|
1058
1237
|
|
|
1059
|
-
Update
|
|
1238
|
+
Update/Create Ping Identity Provider
|
|
1060
1239
|
|
|
1061
1240
|
|
|
1062
1241
|
|
|
1063
|
-
Wraps PUT /api/v2/identityproviders/
|
|
1242
|
+
Wraps PUT /api/v2/identityproviders/ping
|
|
1064
1243
|
|
|
1065
1244
|
|
|
1066
1245
|
### Example
|
|
@@ -1080,14 +1259,15 @@ end
|
|
|
1080
1259
|
|
|
1081
1260
|
api_instance = PureCloud::IdentityProviderApi.new
|
|
1082
1261
|
|
|
1083
|
-
body = PureCloud::
|
|
1262
|
+
body = PureCloud::PingIdentity.new # PingIdentity | Provider
|
|
1084
1263
|
|
|
1085
1264
|
|
|
1086
1265
|
begin
|
|
1087
|
-
#Update
|
|
1088
|
-
api_instance.
|
|
1266
|
+
#Update/Create Ping Identity Provider
|
|
1267
|
+
result = api_instance.put_ping(body)
|
|
1268
|
+
p result
|
|
1089
1269
|
rescue PureCloud::ApiError => e
|
|
1090
|
-
puts "Exception when calling IdentityProviderApi->
|
|
1270
|
+
puts "Exception when calling IdentityProviderApi->put_ping: #{e}"
|
|
1091
1271
|
end
|
|
1092
1272
|
~~~
|
|
1093
1273
|
|
|
@@ -1095,13 +1275,13 @@ end
|
|
|
1095
1275
|
|
|
1096
1276
|
Name | Type | Description | Notes
|
|
1097
1277
|
------------- | ------------- | ------------- | -------------
|
|
1098
|
-
**body** | [**
|
|
1278
|
+
**body** | [**PingIdentity**](PingIdentity.html)| Provider |
|
|
1099
1279
|
{: class="table table-striped"}
|
|
1100
1280
|
|
|
1101
1281
|
|
|
1102
1282
|
### Return type
|
|
1103
1283
|
|
|
1104
|
-
|
|
1284
|
+
[**OAuthProvider**](OAuthProvider.html)
|
|
1105
1285
|
|
|
1106
1286
|
### HTTP request headers
|
|
1107
1287
|
|
|
@@ -1112,7 +1292,7 @@ nil (empty response body)
|
|
|
1112
1292
|
|
|
1113
1293
|
<a name="put_purecloud"></a>
|
|
1114
1294
|
|
|
1115
|
-
## - put_purecloud(body)
|
|
1295
|
+
## -[**OAuthProvider**](OAuthProvider.html) put_purecloud(body)
|
|
1116
1296
|
|
|
1117
1297
|
Update/Create PureCloud Identity Provider
|
|
1118
1298
|
|
|
@@ -1143,7 +1323,8 @@ body = PureCloud::PureCloud.new # PureCloud | Provider
|
|
|
1143
1323
|
|
|
1144
1324
|
begin
|
|
1145
1325
|
#Update/Create PureCloud Identity Provider
|
|
1146
|
-
api_instance.put_purecloud(body)
|
|
1326
|
+
result = api_instance.put_purecloud(body)
|
|
1327
|
+
p result
|
|
1147
1328
|
rescue PureCloud::ApiError => e
|
|
1148
1329
|
puts "Exception when calling IdentityProviderApi->put_purecloud: #{e}"
|
|
1149
1330
|
end
|
|
@@ -1159,7 +1340,7 @@ Name | Type | Description | Notes
|
|
|
1159
1340
|
|
|
1160
1341
|
### Return type
|
|
1161
1342
|
|
|
1162
|
-
|
|
1343
|
+
[**OAuthProvider**](OAuthProvider.html)
|
|
1163
1344
|
|
|
1164
1345
|
### HTTP request headers
|
|
1165
1346
|
|
|
@@ -1170,7 +1351,7 @@ nil (empty response body)
|
|
|
1170
1351
|
|
|
1171
1352
|
<a name="put_salesforce"></a>
|
|
1172
1353
|
|
|
1173
|
-
## - put_salesforce(body)
|
|
1354
|
+
## -[**OAuthProvider**](OAuthProvider.html) put_salesforce(body)
|
|
1174
1355
|
|
|
1175
1356
|
Update/Create Salesforce Identity Provider
|
|
1176
1357
|
|
|
@@ -1201,7 +1382,8 @@ body = PureCloud::Salesforce.new # Salesforce | Provider
|
|
|
1201
1382
|
|
|
1202
1383
|
begin
|
|
1203
1384
|
#Update/Create Salesforce Identity Provider
|
|
1204
|
-
api_instance.put_salesforce(body)
|
|
1385
|
+
result = api_instance.put_salesforce(body)
|
|
1386
|
+
p result
|
|
1205
1387
|
rescue PureCloud::ApiError => e
|
|
1206
1388
|
puts "Exception when calling IdentityProviderApi->put_salesforce: #{e}"
|
|
1207
1389
|
end
|
|
@@ -1217,7 +1399,7 @@ Name | Type | Description | Notes
|
|
|
1217
1399
|
|
|
1218
1400
|
### Return type
|
|
1219
1401
|
|
|
1220
|
-
|
|
1402
|
+
[**OAuthProvider**](OAuthProvider.html)
|
|
1221
1403
|
|
|
1222
1404
|
### HTTP request headers
|
|
1223
1405
|
|