purecloud 0.53.1 → 0.54.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 -0
- data/config-ruby.json +1 -1
- data/doc_out/ADFS.html.md +1 -1
- data/doc_out/Adjacents.html.md +15 -0
- data/doc_out/AgentActivityEntityListing.html.md +2 -2
- data/doc_out/AttemptLimitsEntityListing.html.md +2 -2
- data/doc_out/AttributeEntityListing.html.md +2 -2
- data/doc_out/CalibrationEntityListing.html.md +2 -2
- data/doc_out/CallConversationEntityListing.html.md +2 -2
- data/doc_out/CallConversationNotificationCallMediaParticipant.html.md +2 -0
- data/doc_out/CallConversationNotificationParticipants.html.md +3 -1
- data/doc_out/CallableTimeSetEntityListing.html.md +2 -2
- data/doc_out/CallbackConversationEntityListing.html.md +2 -2
- data/doc_out/CallbackConversationNotificationCallbackMediaParticipant.html.md +2 -0
- data/doc_out/CallbackConversationNotificationParticipants.html.md +2 -0
- data/doc_out/CampaignEntityListing.html.md +2 -2
- data/doc_out/CampaignSequenceEntityListing.html.md +2 -2
- data/doc_out/CertificateAuthorityEntityListing.html.md +2 -2
- data/doc_out/ChannelEntityListing.html.md +2 -2
- data/doc_out/ChatConversationEntityListing.html.md +2 -2
- data/doc_out/ChatConversationNotificationChatMediaParticipant.html.md +2 -0
- data/doc_out/ChatConversationNotificationParticipants.html.md +2 -0
- data/doc_out/CobrowseConversationEntityListing.html.md +2 -2
- data/doc_out/CobrowseConversationNotificationCobrowseMediaParticipant.html.md +2 -0
- data/doc_out/CobrowseConversationNotificationParticipants.html.md +2 -0
- data/doc_out/CommandStatusEntityListing.html.md +2 -2
- data/doc_out/ContactListEntityListing.html.md +2 -2
- data/doc_out/ConversationEntityListing.html.md +2 -2
- data/doc_out/ConversationNotificationParticipant.html.md +1 -0
- data/doc_out/ConversationNotificationParticipants.html.md +14 -13
- data/doc_out/CustomerInteractionCenter.html.md +1 -1
- data/doc_out/DIDEntityListing.html.md +2 -2
- data/doc_out/DIDPoolEntityListing.html.md +2 -2
- data/doc_out/DncListEntityListing.html.md +2 -2
- data/doc_out/DocumentAuditEntityListing.html.md +2 -2
- data/doc_out/DocumentEntityListing.html.md +2 -2
- data/doc_out/DomainEdgeSoftwareVersionDtoEntityListing.html.md +2 -2
- data/doc_out/DomainEntityListing.html.md +2 -2
- data/doc_out/DomainEntityListingEvaluationForm.html.md +2 -2
- data/doc_out/DomainEntityListingQueryResult.html.md +2 -2
- data/doc_out/EdgeEntityListing.html.md +2 -2
- data/doc_out/EdgeGroupEntityListing.html.md +2 -2
- data/doc_out/EdgeLineEntityListing.html.md +2 -2
- data/doc_out/EmailConversationEntityListing.html.md +2 -2
- data/doc_out/EmailConversationNotificationEmailMediaParticipant.html.md +2 -0
- data/doc_out/EmailConversationNotificationParticipants.html.md +12 -10
- data/doc_out/EmailMessageListing.html.md +2 -2
- data/doc_out/EncryptionKeyEntityListing.html.md +2 -2
- data/doc_out/EndpointEntityListing.html.md +2 -2
- data/doc_out/EvaluationEntityListing.html.md +2 -2
- data/doc_out/EvaluationFormEntityListing.html.md +2 -2
- data/doc_out/EvaluatorActivityEntityListing.html.md +2 -2
- data/doc_out/ExtensionEntityListing.html.md +2 -2
- data/doc_out/ExtensionPoolEntityListing.html.md +2 -2
- data/doc_out/FaxDocumentEntityListing.html.md +2 -2
- data/doc_out/GroupEntityListing.html.md +2 -2
- data/doc_out/HeartBeatAlertContainer.html.md +2 -2
- data/doc_out/HeartBeatRuleContainer.html.md +2 -2
- data/doc_out/InboundDomainEntityListing.html.md +2 -2
- data/doc_out/InboundRouteEntityListing.html.md +2 -2
- data/doc_out/InteractionStatsAlertContainer.html.md +2 -2
- data/doc_out/InteractionStatsRuleContainer.html.md +2 -2
- data/doc_out/JsonNode.html.md +1 -1
- data/doc_out/KeywordSetEntityListing.html.md +2 -2
- data/doc_out/LanguageEntityListing.html.md +2 -2
- data/doc_out/LibraryEntityListing.html.md +2 -2
- data/doc_out/LineBaseEntityListing.html.md +2 -2
- data/doc_out/LineEntityListing.html.md +2 -2
- data/doc_out/LogicalInterfaceEntityListing.html.md +2 -2
- data/doc_out/OAuthClientEntityListing.html.md +2 -2
- data/doc_out/OAuthProviderEntityListing.html.md +2 -2
- data/doc_out/Okta.html.md +1 -1
- data/doc_out/OneLogin.html.md +1 -1
- data/doc_out/OrganizationPresenceEntityListing.html.md +2 -2
- data/doc_out/OrganizationRoleEntityListing.html.md +2 -2
- data/doc_out/OrphanRecordingListing.html.md +2 -2
- data/doc_out/OutboundRouteEntityListing.html.md +2 -2
- data/doc_out/PermissionCollectionEntityListing.html.md +2 -2
- data/doc_out/PhoneBaseEntityListing.html.md +2 -2
- data/doc_out/PhoneEntityListing.html.md +2 -2
- data/doc_out/PhoneMetaBaseEntityListing.html.md +2 -2
- data/doc_out/PhysicalInterfaceEntityListing.html.md +2 -2
- data/doc_out/PolicyEntityListing.html.md +2 -2
- data/doc_out/QualityAuditPage.html.md +2 -2
- data/doc_out/QueueEntityListing.html.md +2 -2
- data/doc_out/QueueMemberEntityListing.html.md +2 -2
- data/doc_out/QueueMemberNotification.html.md +16 -0
- data/doc_out/ReportMetaDataEntityListing.html.md +2 -2
- data/doc_out/ReportRunEntryEntityDomainListing.html.md +2 -2
- data/doc_out/ReportScheduleEntityListing.html.md +2 -2
- data/doc_out/ResponseEntityList.html.md +2 -2
- data/doc_out/ResponseEntityListing.html.md +2 -2
- data/doc_out/ResponseSetEntityListing.html.md +2 -2
- data/doc_out/RuleSetEntityListing.html.md +2 -2
- data/doc_out/Salesforce.html.md +1 -1
- data/doc_out/SchemaCategoryEntityListing.html.md +2 -2
- data/doc_out/SchemaReferenceEntityListing.html.md +2 -2
- data/doc_out/ScreenRecordingSessionListing.html.md +2 -2
- data/doc_out/ScreenShareConversationNotificationParticipants.html.md +3 -1
- data/doc_out/ScreenShareConversationNotificationScreenShareMediaParticipant.html.md +2 -0
- data/doc_out/SecurityProfileEntityListing.html.md +2 -2
- data/doc_out/ShareEntityListing.html.md +2 -2
- data/doc_out/SiteEntityListing.html.md +2 -2
- data/doc_out/SkillEntityListing.html.md +2 -2
- data/doc_out/SocialConversationNotificationParticipants.html.md +2 -0
- data/doc_out/SocialConversationNotificationSocialMediaParticipant.html.md +2 -0
- data/doc_out/StationEntityListing.html.md +2 -2
- data/doc_out/TagValueEntityListing.html.md +2 -2
- data/doc_out/TimeZoneEntityListing.html.md +2 -2
- data/doc_out/TrunkEntityListing.html.md +2 -2
- data/doc_out/TrunkMetabaseEntityListing.html.md +2 -2
- data/doc_out/UserEntityListing.html.md +2 -2
- data/doc_out/UserMe.html.md +4 -0
- data/doc_out/UserQueueEntityListing.html.md +2 -2
- data/doc_out/UserRecordingEntityListing.html.md +2 -2
- data/doc_out/UserRoutingStatusNotification.html.md +13 -0
- data/doc_out/UserRoutingStatusNotificationRoutingStatus.html.md +14 -0
- data/doc_out/UserSkillEntityListing.html.md +2 -2
- data/doc_out/UsersApi.html.md +246 -0
- data/doc_out/UsersEntityListing.html.md +2 -2
- data/doc_out/VideoConversationNotificationParticipants.html.md +2 -0
- data/doc_out/VideoConversationNotificationVideoMediaParticipant.html.md +2 -0
- data/doc_out/VoicemailMessageNotification.html.md +20 -0
- data/doc_out/WorkspaceEntityListing.html.md +2 -2
- data/doc_out/WorkspaceMemberEntityListing.html.md +2 -2
- data/doc_out/WrapupCodeEntityListing.html.md +2 -2
- data/doc_out/index.html.md +3 -3
- data/lib/purecloud.rb +5 -0
- data/lib/purecloud/api/users_api.rb +257 -0
- data/lib/purecloud/api_client.rb +1 -1
- data/lib/purecloud/models/adfs.rb +11 -11
- data/lib/purecloud/models/adjacents.rb +191 -0
- data/lib/purecloud/models/agent_activity_entity_listing.rb +21 -21
- data/lib/purecloud/models/attempt_limits_entity_listing.rb +21 -21
- data/lib/purecloud/models/attribute_entity_listing.rb +21 -21
- data/lib/purecloud/models/calibration_entity_listing.rb +21 -21
- data/lib/purecloud/models/call_conversation_entity_listing.rb +21 -21
- data/lib/purecloud/models/call_conversation_notification_call_media_participant.rb +21 -1
- data/lib/purecloud/models/call_conversation_notification_participants.rb +27 -7
- data/lib/purecloud/models/callable_time_set_entity_listing.rb +21 -21
- data/lib/purecloud/models/callback_conversation_entity_listing.rb +21 -21
- data/lib/purecloud/models/callback_conversation_notification_callback_media_participant.rb +21 -1
- data/lib/purecloud/models/callback_conversation_notification_participants.rb +21 -1
- data/lib/purecloud/models/campaign_entity_listing.rb +21 -21
- data/lib/purecloud/models/campaign_sequence_entity_listing.rb +21 -21
- data/lib/purecloud/models/certificate_authority_entity_listing.rb +21 -21
- data/lib/purecloud/models/channel_entity_listing.rb +21 -21
- data/lib/purecloud/models/chat_conversation_entity_listing.rb +21 -21
- data/lib/purecloud/models/chat_conversation_notification_chat_media_participant.rb +21 -1
- data/lib/purecloud/models/chat_conversation_notification_participants.rb +21 -1
- data/lib/purecloud/models/cobrowse_conversation_entity_listing.rb +21 -21
- data/lib/purecloud/models/cobrowse_conversation_notification_cobrowse_media_participant.rb +21 -1
- data/lib/purecloud/models/cobrowse_conversation_notification_participants.rb +21 -1
- data/lib/purecloud/models/command_status_entity_listing.rb +21 -21
- data/lib/purecloud/models/contact_list_entity_listing.rb +21 -21
- data/lib/purecloud/models/conversation_entity_listing.rb +21 -21
- data/lib/purecloud/models/conversation_notification_participant.rb +11 -1
- data/lib/purecloud/models/conversation_notification_participants.rb +138 -128
- data/lib/purecloud/models/customer_interaction_center.rb +11 -11
- data/lib/purecloud/models/did_entity_listing.rb +21 -21
- data/lib/purecloud/models/did_pool_entity_listing.rb +21 -21
- data/lib/purecloud/models/dnc_list_entity_listing.rb +21 -21
- data/lib/purecloud/models/document_audit_entity_listing.rb +21 -21
- data/lib/purecloud/models/document_entity_listing.rb +21 -21
- data/lib/purecloud/models/domain_edge_software_version_dto_entity_listing.rb +21 -21
- data/lib/purecloud/models/domain_entity_listing.rb +21 -21
- data/lib/purecloud/models/domain_entity_listing_evaluation_form.rb +21 -21
- data/lib/purecloud/models/domain_entity_listing_query_result.rb +21 -21
- data/lib/purecloud/models/edge_entity_listing.rb +21 -21
- data/lib/purecloud/models/edge_group_entity_listing.rb +21 -21
- data/lib/purecloud/models/edge_line_entity_listing.rb +21 -21
- data/lib/purecloud/models/email_conversation_entity_listing.rb +21 -21
- data/lib/purecloud/models/email_conversation_notification_email_media_participant.rb +21 -1
- data/lib/purecloud/models/email_conversation_notification_participants.rb +113 -93
- data/lib/purecloud/models/email_message_listing.rb +21 -21
- data/lib/purecloud/models/encryption_key_entity_listing.rb +21 -21
- data/lib/purecloud/models/endpoint_entity_listing.rb +21 -21
- data/lib/purecloud/models/evaluation_entity_listing.rb +21 -21
- data/lib/purecloud/models/evaluation_form_entity_listing.rb +21 -21
- data/lib/purecloud/models/evaluator_activity_entity_listing.rb +21 -21
- data/lib/purecloud/models/extension_entity_listing.rb +21 -21
- data/lib/purecloud/models/extension_pool_entity_listing.rb +21 -21
- data/lib/purecloud/models/fax_document_entity_listing.rb +21 -21
- data/lib/purecloud/models/group_entity_listing.rb +21 -21
- data/lib/purecloud/models/heart_beat_alert_container.rb +21 -21
- data/lib/purecloud/models/heart_beat_rule_container.rb +21 -21
- data/lib/purecloud/models/inbound_domain_entity_listing.rb +21 -21
- data/lib/purecloud/models/inbound_route_entity_listing.rb +21 -21
- data/lib/purecloud/models/interaction_stats_alert_container.rb +21 -21
- data/lib/purecloud/models/interaction_stats_rule_container.rb +21 -21
- data/lib/purecloud/models/json_node.rb +13 -13
- data/lib/purecloud/models/keyword_set_entity_listing.rb +21 -21
- data/lib/purecloud/models/language_entity_listing.rb +21 -21
- data/lib/purecloud/models/library_entity_listing.rb +21 -21
- data/lib/purecloud/models/line_base_entity_listing.rb +21 -21
- data/lib/purecloud/models/line_entity_listing.rb +21 -21
- data/lib/purecloud/models/logical_interface_entity_listing.rb +21 -21
- data/lib/purecloud/models/o_auth_client_entity_listing.rb +21 -21
- data/lib/purecloud/models/o_auth_provider_entity_listing.rb +21 -21
- data/lib/purecloud/models/okta.rb +11 -11
- data/lib/purecloud/models/one_login.rb +11 -11
- data/lib/purecloud/models/organization_presence_entity_listing.rb +21 -21
- data/lib/purecloud/models/organization_role_entity_listing.rb +21 -21
- data/lib/purecloud/models/orphan_recording_listing.rb +21 -21
- data/lib/purecloud/models/outbound_route_entity_listing.rb +21 -21
- data/lib/purecloud/models/permission_collection_entity_listing.rb +21 -21
- data/lib/purecloud/models/phone_base_entity_listing.rb +21 -21
- data/lib/purecloud/models/phone_entity_listing.rb +21 -21
- data/lib/purecloud/models/phone_meta_base_entity_listing.rb +21 -21
- data/lib/purecloud/models/physical_interface_entity_listing.rb +21 -21
- data/lib/purecloud/models/policy_entity_listing.rb +21 -21
- data/lib/purecloud/models/quality_audit_page.rb +21 -21
- data/lib/purecloud/models/queue_entity_listing.rb +21 -21
- data/lib/purecloud/models/queue_member_entity_listing.rb +21 -21
- data/lib/purecloud/models/queue_member_notification.rb +195 -0
- data/lib/purecloud/models/report_meta_data_entity_listing.rb +21 -21
- data/lib/purecloud/models/report_run_entry_entity_domain_listing.rb +21 -21
- data/lib/purecloud/models/report_schedule_entity_listing.rb +21 -21
- data/lib/purecloud/models/response_entity_list.rb +21 -21
- data/lib/purecloud/models/response_entity_listing.rb +21 -21
- data/lib/purecloud/models/response_set_entity_listing.rb +21 -21
- data/lib/purecloud/models/rule_set_entity_listing.rb +21 -21
- data/lib/purecloud/models/salesforce.rb +11 -11
- data/lib/purecloud/models/schema_category_entity_listing.rb +21 -21
- data/lib/purecloud/models/schema_reference_entity_listing.rb +21 -21
- data/lib/purecloud/models/screen_recording_session_listing.rb +21 -21
- data/lib/purecloud/models/screen_share_conversation_notification_participants.rb +31 -11
- data/lib/purecloud/models/screen_share_conversation_notification_screen_share_media_participant.rb +21 -1
- data/lib/purecloud/models/security_profile_entity_listing.rb +21 -21
- data/lib/purecloud/models/share_entity_listing.rb +21 -21
- data/lib/purecloud/models/site_entity_listing.rb +21 -21
- data/lib/purecloud/models/skill_entity_listing.rb +21 -21
- data/lib/purecloud/models/social_conversation_notification_participants.rb +21 -1
- data/lib/purecloud/models/social_conversation_notification_social_media_participant.rb +21 -1
- data/lib/purecloud/models/station_entity_listing.rb +21 -21
- data/lib/purecloud/models/tag_value_entity_listing.rb +21 -21
- data/lib/purecloud/models/time_zone_entity_listing.rb +21 -21
- data/lib/purecloud/models/trunk_entity_listing.rb +21 -21
- data/lib/purecloud/models/trunk_metabase_entity_listing.rb +21 -21
- data/lib/purecloud/models/user_entity_listing.rb +21 -21
- data/lib/purecloud/models/user_me.rb +51 -1
- data/lib/purecloud/models/user_queue_entity_listing.rb +21 -21
- data/lib/purecloud/models/user_recording_entity_listing.rb +21 -21
- data/lib/purecloud/models/user_routing_status_notification.rb +165 -0
- data/lib/purecloud/models/user_routing_status_notification_routing_status.rb +184 -0
- data/lib/purecloud/models/user_skill_entity_listing.rb +21 -21
- data/lib/purecloud/models/users_entity_listing.rb +21 -21
- data/lib/purecloud/models/video_conversation_notification_participants.rb +21 -1
- data/lib/purecloud/models/video_conversation_notification_video_media_participant.rb +21 -1
- data/lib/purecloud/models/voicemail_message_notification.rb +235 -0
- data/lib/purecloud/models/workspace_entity_listing.rb +21 -21
- data/lib/purecloud/models/workspace_member_entity_listing.rb +21 -21
- data/lib/purecloud/models/wrapup_code_entity_listing.rb +21 -21
- data/lib/purecloud/version.rb +1 -1
- data/newVersion.md +1 -1
- data/swagger.json +1 -1
- data/version.json +1 -1
- metadata +12 -2
|
@@ -11,11 +11,11 @@ title: UserSkillEntityListing
|
|
|
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] |
|
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/doc_out/UsersApi.html.md
CHANGED
|
@@ -16,7 +16,10 @@ Method | HTTP request | Description
|
|
|
16
16
|
|[**get_me**](UsersApi.html#get_me) | **GET** /api/v2/users/me | Get current user details.|
|
|
17
17
|
|[**get_search**](UsersApi.html#get_search) | **GET** /api/v2/users/search | Search users using the q64 value returned from a previous search|
|
|
18
18
|
|[**get_user_id**](UsersApi.html#get_user_id) | **GET** /api/v2/users/{userId} | Get user.|
|
|
19
|
+
|[**get_user_id_adjacents**](UsersApi.html#get_user_id_adjacents) | **GET** /api/v2/users/{userId}/adjacents | Get adjacents|
|
|
19
20
|
|[**get_user_id_callforwarding**](UsersApi.html#get_user_id_callforwarding) | **GET** /api/v2/users/{userId}/callforwarding | Get a user's CallForwarding|
|
|
21
|
+
|[**get_user_id_directreports**](UsersApi.html#get_user_id_directreports) | **GET** /api/v2/users/{userId}/directreports | Get direct reports|
|
|
22
|
+
|[**get_user_id_favorites**](UsersApi.html#get_user_id_favorites) | **GET** /api/v2/users/{userId}/favorites | Get favorites|
|
|
20
23
|
|[**get_user_id_geolocations_client_id**](UsersApi.html#get_user_id_geolocations_client_id) | **GET** /api/v2/users/{userId}/geolocations/{clientId} | Get a user's Geolocation|
|
|
21
24
|
|[**get_user_id_outofoffice**](UsersApi.html#get_user_id_outofoffice) | **GET** /api/v2/users/{userId}/outofoffice | Get a OutOfOffice|
|
|
22
25
|
|[**get_user_id_profileskills**](UsersApi.html#get_user_id_profileskills) | **GET** /api/v2/users/{userId}/profileskills | List profile skills for a user|
|
|
@@ -25,6 +28,7 @@ Method | HTTP request | Description
|
|
|
25
28
|
|[**get_user_id_routingskills**](UsersApi.html#get_user_id_routingskills) | **GET** /api/v2/users/{userId}/routingskills | List routing skills for user|
|
|
26
29
|
|[**get_user_id_routingstatus**](UsersApi.html#get_user_id_routingstatus) | **GET** /api/v2/users/{userId}/routingstatus | Fetch the routing status of a user|
|
|
27
30
|
|[**get_user_id_station**](UsersApi.html#get_user_id_station) | **GET** /api/v2/users/{userId}/station | Get station information for user|
|
|
31
|
+
|[**get_user_id_superiors**](UsersApi.html#get_user_id_superiors) | **GET** /api/v2/users/{userId}/superiors | Get superiors|
|
|
28
32
|
|[**get_users**](UsersApi.html#get_users) | **GET** /api/v2/users | Get the list of available users.|
|
|
29
33
|
|[**patch_user_id**](UsersApi.html#patch_user_id) | **PATCH** /api/v2/users/{userId} | Update user|
|
|
30
34
|
|[**patch_user_id_callforwarding**](UsersApi.html#patch_user_id_callforwarding) | **PATCH** /api/v2/users/{userId}/callforwarding | Patch a user's CallForwarding|
|
|
@@ -503,6 +507,65 @@ Name | Type | Description | Notes
|
|
|
503
507
|
|
|
504
508
|
|
|
505
509
|
|
|
510
|
+
<a name="get_user_id_adjacents"></a>
|
|
511
|
+
|
|
512
|
+
## - get_user_id_adjacents(user_id, opts)
|
|
513
|
+
|
|
514
|
+
Get adjacents
|
|
515
|
+
|
|
516
|
+
|
|
517
|
+
|
|
518
|
+
### Example
|
|
519
|
+
~~~ruby
|
|
520
|
+
# load the gem
|
|
521
|
+
require 'purecloud'
|
|
522
|
+
# setup authorization
|
|
523
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
524
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
525
|
+
environment = "mypurecloud.com"
|
|
526
|
+
|
|
527
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
528
|
+
|
|
529
|
+
PureCloud.configure do |config|
|
|
530
|
+
config.access_token = @authToken
|
|
531
|
+
end
|
|
532
|
+
|
|
533
|
+
api_instance = PureCloud::UsersApi.new
|
|
534
|
+
|
|
535
|
+
user_id = "user_id_example" # String | User ID
|
|
536
|
+
|
|
537
|
+
opts = {
|
|
538
|
+
expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
|
|
539
|
+
}
|
|
540
|
+
|
|
541
|
+
begin
|
|
542
|
+
#Get adjacents
|
|
543
|
+
api_instance.get_user_id_adjacents(user_id, opts)
|
|
544
|
+
rescue PureCloud::ApiError => e
|
|
545
|
+
puts "Exception when calling UsersApi->get_user_id_adjacents: #{e}"
|
|
546
|
+
end
|
|
547
|
+
~~~
|
|
548
|
+
|
|
549
|
+
### Parameters
|
|
550
|
+
|
|
551
|
+
Name | Type | Description | Notes
|
|
552
|
+
------------- | ------------- | ------------- | -------------
|
|
553
|
+
**user_id** | **String**| User ID |
|
|
554
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional]
|
|
555
|
+
{: class="table table-striped"}
|
|
556
|
+
|
|
557
|
+
|
|
558
|
+
### Return type
|
|
559
|
+
|
|
560
|
+
nil (empty response body)
|
|
561
|
+
|
|
562
|
+
### HTTP request headers
|
|
563
|
+
|
|
564
|
+
- **Content-Type**: application/json
|
|
565
|
+
- **Accept**: application/json
|
|
566
|
+
|
|
567
|
+
|
|
568
|
+
|
|
506
569
|
<a name="get_user_id_callforwarding"></a>
|
|
507
570
|
|
|
508
571
|
## -[**CallForwarding**](CallForwarding.html) get_user_id_callforwarding(user_id)
|
|
@@ -559,6 +622,130 @@ Name | Type | Description | Notes
|
|
|
559
622
|
|
|
560
623
|
|
|
561
624
|
|
|
625
|
+
<a name="get_user_id_directreports"></a>
|
|
626
|
+
|
|
627
|
+
## - get_user_id_directreports(user_id, opts)
|
|
628
|
+
|
|
629
|
+
Get direct reports
|
|
630
|
+
|
|
631
|
+
|
|
632
|
+
|
|
633
|
+
### Example
|
|
634
|
+
~~~ruby
|
|
635
|
+
# load the gem
|
|
636
|
+
require 'purecloud'
|
|
637
|
+
# setup authorization
|
|
638
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
639
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
640
|
+
environment = "mypurecloud.com"
|
|
641
|
+
|
|
642
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
643
|
+
|
|
644
|
+
PureCloud.configure do |config|
|
|
645
|
+
config.access_token = @authToken
|
|
646
|
+
end
|
|
647
|
+
|
|
648
|
+
api_instance = PureCloud::UsersApi.new
|
|
649
|
+
|
|
650
|
+
user_id = "user_id_example" # String | User ID
|
|
651
|
+
|
|
652
|
+
opts = {
|
|
653
|
+
expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
|
|
654
|
+
}
|
|
655
|
+
|
|
656
|
+
begin
|
|
657
|
+
#Get direct reports
|
|
658
|
+
api_instance.get_user_id_directreports(user_id, opts)
|
|
659
|
+
rescue PureCloud::ApiError => e
|
|
660
|
+
puts "Exception when calling UsersApi->get_user_id_directreports: #{e}"
|
|
661
|
+
end
|
|
662
|
+
~~~
|
|
663
|
+
|
|
664
|
+
### Parameters
|
|
665
|
+
|
|
666
|
+
Name | Type | Description | Notes
|
|
667
|
+
------------- | ------------- | ------------- | -------------
|
|
668
|
+
**user_id** | **String**| User ID |
|
|
669
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional]
|
|
670
|
+
{: class="table table-striped"}
|
|
671
|
+
|
|
672
|
+
|
|
673
|
+
### Return type
|
|
674
|
+
|
|
675
|
+
nil (empty response body)
|
|
676
|
+
|
|
677
|
+
### HTTP request headers
|
|
678
|
+
|
|
679
|
+
- **Content-Type**: application/json
|
|
680
|
+
- **Accept**: application/json
|
|
681
|
+
|
|
682
|
+
|
|
683
|
+
|
|
684
|
+
<a name="get_user_id_favorites"></a>
|
|
685
|
+
|
|
686
|
+
## - get_user_id_favorites(user_id, opts)
|
|
687
|
+
|
|
688
|
+
Get favorites
|
|
689
|
+
|
|
690
|
+
|
|
691
|
+
|
|
692
|
+
### Example
|
|
693
|
+
~~~ruby
|
|
694
|
+
# load the gem
|
|
695
|
+
require 'purecloud'
|
|
696
|
+
# setup authorization
|
|
697
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
698
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
699
|
+
environment = "mypurecloud.com"
|
|
700
|
+
|
|
701
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
702
|
+
|
|
703
|
+
PureCloud.configure do |config|
|
|
704
|
+
config.access_token = @authToken
|
|
705
|
+
end
|
|
706
|
+
|
|
707
|
+
api_instance = PureCloud::UsersApi.new
|
|
708
|
+
|
|
709
|
+
user_id = "user_id_example" # String | User ID
|
|
710
|
+
|
|
711
|
+
opts = {
|
|
712
|
+
page_size: 25, # Integer | Page size
|
|
713
|
+
page_number: 1, # Integer | Page number
|
|
714
|
+
sort_order: "ASC", # String | Sort order
|
|
715
|
+
expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
|
|
716
|
+
}
|
|
717
|
+
|
|
718
|
+
begin
|
|
719
|
+
#Get favorites
|
|
720
|
+
api_instance.get_user_id_favorites(user_id, opts)
|
|
721
|
+
rescue PureCloud::ApiError => e
|
|
722
|
+
puts "Exception when calling UsersApi->get_user_id_favorites: #{e}"
|
|
723
|
+
end
|
|
724
|
+
~~~
|
|
725
|
+
|
|
726
|
+
### Parameters
|
|
727
|
+
|
|
728
|
+
Name | Type | Description | Notes
|
|
729
|
+
------------- | ------------- | ------------- | -------------
|
|
730
|
+
**user_id** | **String**| User ID |
|
|
731
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25]
|
|
732
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1]
|
|
733
|
+
**sort_order** | **String**| Sort order | [optional] [default to ASC]
|
|
734
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional]
|
|
735
|
+
{: class="table table-striped"}
|
|
736
|
+
|
|
737
|
+
|
|
738
|
+
### Return type
|
|
739
|
+
|
|
740
|
+
nil (empty response body)
|
|
741
|
+
|
|
742
|
+
### HTTP request headers
|
|
743
|
+
|
|
744
|
+
- **Content-Type**: application/json
|
|
745
|
+
- **Accept**: application/json
|
|
746
|
+
|
|
747
|
+
|
|
748
|
+
|
|
562
749
|
<a name="get_user_id_geolocations_client_id"></a>
|
|
563
750
|
|
|
564
751
|
## -[**Geolocation**](Geolocation.html) get_user_id_geolocations_client_id(user_id, client_id)
|
|
@@ -1026,6 +1213,65 @@ Name | Type | Description | Notes
|
|
|
1026
1213
|
|
|
1027
1214
|
|
|
1028
1215
|
|
|
1216
|
+
<a name="get_user_id_superiors"></a>
|
|
1217
|
+
|
|
1218
|
+
## - get_user_id_superiors(user_id, opts)
|
|
1219
|
+
|
|
1220
|
+
Get superiors
|
|
1221
|
+
|
|
1222
|
+
|
|
1223
|
+
|
|
1224
|
+
### Example
|
|
1225
|
+
~~~ruby
|
|
1226
|
+
# load the gem
|
|
1227
|
+
require 'purecloud'
|
|
1228
|
+
# setup authorization
|
|
1229
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1230
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1231
|
+
environment = "mypurecloud.com"
|
|
1232
|
+
|
|
1233
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1234
|
+
|
|
1235
|
+
PureCloud.configure do |config|
|
|
1236
|
+
config.access_token = @authToken
|
|
1237
|
+
end
|
|
1238
|
+
|
|
1239
|
+
api_instance = PureCloud::UsersApi.new
|
|
1240
|
+
|
|
1241
|
+
user_id = "user_id_example" # String | User ID
|
|
1242
|
+
|
|
1243
|
+
opts = {
|
|
1244
|
+
expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
|
|
1245
|
+
}
|
|
1246
|
+
|
|
1247
|
+
begin
|
|
1248
|
+
#Get superiors
|
|
1249
|
+
api_instance.get_user_id_superiors(user_id, opts)
|
|
1250
|
+
rescue PureCloud::ApiError => e
|
|
1251
|
+
puts "Exception when calling UsersApi->get_user_id_superiors: #{e}"
|
|
1252
|
+
end
|
|
1253
|
+
~~~
|
|
1254
|
+
|
|
1255
|
+
### Parameters
|
|
1256
|
+
|
|
1257
|
+
Name | Type | Description | Notes
|
|
1258
|
+
------------- | ------------- | ------------- | -------------
|
|
1259
|
+
**user_id** | **String**| User ID |
|
|
1260
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional]
|
|
1261
|
+
{: class="table table-striped"}
|
|
1262
|
+
|
|
1263
|
+
|
|
1264
|
+
### Return type
|
|
1265
|
+
|
|
1266
|
+
nil (empty response body)
|
|
1267
|
+
|
|
1268
|
+
### HTTP request headers
|
|
1269
|
+
|
|
1270
|
+
- **Content-Type**: application/json
|
|
1271
|
+
- **Accept**: application/json
|
|
1272
|
+
|
|
1273
|
+
|
|
1274
|
+
|
|
1029
1275
|
<a name="get_users"></a>
|
|
1030
1276
|
|
|
1031
1277
|
## -[**UsersEntityListing**](UsersEntityListing.html) get_users(opts)
|
|
@@ -11,11 +11,11 @@ title: UsersEntityListing
|
|
|
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] |
|
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -22,9 +22,11 @@ title: VideoConversationNotificationParticipants
|
|
|
22
22
|
| **wrapup_prompt** | **String** | | [optional] |
|
|
23
23
|
| **name** | **String** | | [optional] |
|
|
24
24
|
| **wrapup_timeout_ms** | **Integer** | | [optional] |
|
|
25
|
+
| **external_organization** | [**VideoConversationNotificationUriReference**](VideoConversationNotificationUriReference.html) | | [optional] |
|
|
25
26
|
| **held** | **BOOLEAN** | | [optional] |
|
|
26
27
|
| **audio_muted** | **BOOLEAN** | | [optional] |
|
|
27
28
|
| **wrapup_required** | **BOOLEAN** | | [optional] |
|
|
29
|
+
| **external_contact** | [**VideoConversationNotificationUriReference**](VideoConversationNotificationUriReference.html) | | [optional] |
|
|
28
30
|
| **provider** | **String** | | [optional] |
|
|
29
31
|
| **script** | [**VideoConversationNotificationUriReference**](VideoConversationNotificationUriReference.html) | | [optional] |
|
|
30
32
|
| **disconnect_type** | **String** | | [optional] |
|
|
@@ -29,6 +29,8 @@ title: VideoConversationNotificationVideoMediaParticipant
|
|
|
29
29
|
| **wrapup_timeout_ms** | **Integer** | | [optional] |
|
|
30
30
|
| **wrapup_skipped** | **BOOLEAN** | | [optional] |
|
|
31
31
|
| **provider** | **String** | | [optional] |
|
|
32
|
+
| **external_contact** | [**VideoConversationNotificationUriReference**](VideoConversationNotificationUriReference.html) | | [optional] |
|
|
33
|
+
| **external_organization** | [**VideoConversationNotificationUriReference**](VideoConversationNotificationUriReference.html) | | [optional] |
|
|
32
34
|
| **audio_muted** | **BOOLEAN** | | [optional] |
|
|
33
35
|
| **video_muted** | **BOOLEAN** | | [optional] |
|
|
34
36
|
| **sharing_screen** | **BOOLEAN** | | [optional] |
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: VoicemailMessageNotification
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::VoicemailMessageNotification
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **id** | **String** | | [optional] |
|
|
11
|
+
| **read** | **BOOLEAN** | | [optional] |
|
|
12
|
+
| **audio_recording_duration_seconds** | **Integer** | | [optional] |
|
|
13
|
+
| **audio_recording_size_bytes** | **Integer** | | [optional] |
|
|
14
|
+
| **created_date** | **DateTime** | | [optional] |
|
|
15
|
+
| **modified_date** | **DateTime** | | [optional] |
|
|
16
|
+
| **caller_address** | **String** | | [optional] |
|
|
17
|
+
| **caller_name** | **String** | | [optional] |
|
|
18
|
+
{: class="table table-striped"}
|
|
19
|
+
|
|
20
|
+
|
|
@@ -11,11 +11,11 @@ title: WorkspaceEntityListing
|
|
|
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] |
|
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -11,11 +11,11 @@ title: WorkspaceMemberEntityListing
|
|
|
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] |
|
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -11,11 +11,11 @@ title: WrapupCodeEntityListing
|
|
|
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] |
|
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/doc_out/index.html.md
CHANGED
|
@@ -9,8 +9,8 @@ With the PureCloud Platform API, you can control all aspects of your PureCloud e
|
|
|
9
9
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
|
10
10
|
|
|
11
11
|
- API version: v2
|
|
12
|
-
- Package version: 0.
|
|
13
|
-
- Build date: 2016-10-
|
|
12
|
+
- Package version: 0.54.1
|
|
13
|
+
- Build date: 2016-10-18T18:59:42.589Z
|
|
14
14
|
|
|
15
15
|
For more information, please visit [https://developer.mypurecloud.com](https://developer.mypurecloud.com)
|
|
16
16
|
|
|
@@ -18,7 +18,7 @@ For more information, please visit [https://developer.mypurecloud.com](https://d
|
|
|
18
18
|
|
|
19
19
|
### from rubygems.org
|
|
20
20
|
|
|
21
|
-
gem 'purecloud', '~> 0.
|
|
21
|
+
gem 'purecloud', '~> 0.54.1'
|
|
22
22
|
|
|
23
23
|
### Install from Git
|
|
24
24
|
|
data/lib/purecloud.rb
CHANGED
|
@@ -25,6 +25,7 @@ require 'purecloud/models/adfs'
|
|
|
25
25
|
require 'purecloud/models/actions'
|
|
26
26
|
require 'purecloud/models/acw_settings'
|
|
27
27
|
require 'purecloud/models/address'
|
|
28
|
+
require 'purecloud/models/adjacents'
|
|
28
29
|
require 'purecloud/models/agent'
|
|
29
30
|
require 'purecloud/models/agent_activity'
|
|
30
31
|
require 'purecloud/models/agent_activity_entity_listing'
|
|
@@ -483,6 +484,7 @@ require 'purecloud/models/queue'
|
|
|
483
484
|
require 'purecloud/models/queue_entity_listing'
|
|
484
485
|
require 'purecloud/models/queue_member'
|
|
485
486
|
require 'purecloud/models/queue_member_entity_listing'
|
|
487
|
+
require 'purecloud/models/queue_member_notification'
|
|
486
488
|
require 'purecloud/models/queue_utilization_diagnostic'
|
|
487
489
|
require 'purecloud/models/reaction'
|
|
488
490
|
require 'purecloud/models/recording'
|
|
@@ -612,6 +614,8 @@ require 'purecloud/models/user_recording'
|
|
|
612
614
|
require 'purecloud/models/user_recording_entity_listing'
|
|
613
615
|
require 'purecloud/models/user_routing_skill'
|
|
614
616
|
require 'purecloud/models/user_routing_skill_post'
|
|
617
|
+
require 'purecloud/models/user_routing_status_notification'
|
|
618
|
+
require 'purecloud/models/user_routing_status_notification_routing_status'
|
|
615
619
|
require 'purecloud/models/user_schedule_adherence'
|
|
616
620
|
require 'purecloud/models/user_search_criteria'
|
|
617
621
|
require 'purecloud/models/user_search_request'
|
|
@@ -637,6 +641,7 @@ require 'purecloud/models/voicemail_mailbox_info'
|
|
|
637
641
|
require 'purecloud/models/voicemail_media_info'
|
|
638
642
|
require 'purecloud/models/voicemail_message'
|
|
639
643
|
require 'purecloud/models/voicemail_message_entity_listing'
|
|
644
|
+
require 'purecloud/models/voicemail_message_notification'
|
|
640
645
|
require 'purecloud/models/voicemail_organization_policy'
|
|
641
646
|
require 'purecloud/models/voicemail_user_policy'
|
|
642
647
|
require 'purecloud/models/workspace'
|