purecloud 0.67.1 → 0.68.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 +4 -4
- data/config-ruby.json +1 -1
- data/doc_out/ActivityCode.html.md +20 -0
- data/doc_out/ActivityCodeContainer.html.md +13 -0
- data/doc_out/AgentActivityEntityListing.html.md +2 -2
- data/doc_out/AlertingApi.html.md +137 -35
- data/doc_out/AnalyticsApi.html.md +89 -23
- data/doc_out/AttemptLimitsEntityListing.html.md +2 -2
- data/doc_out/AttemptLimitsNotification.html.md +2 -1
- data/doc_out/AttributeEntityListing.html.md +2 -2
- data/doc_out/AttributesApi.html.md +25 -7
- data/doc_out/AuthorizationApi.html.md +69 -18
- data/doc_out/CalibrationEntityListing.html.md +2 -2
- data/doc_out/CallConversationEntityListing.html.md +2 -2
- data/doc_out/CallConversationNotificationCallMediaParticipant.html.md +1 -1
- data/doc_out/CallConversationNotificationParticipants.html.md +1 -1
- data/doc_out/CallableTimeSetEntityListing.html.md +2 -2
- data/doc_out/CallableTimeSetNotification.html.md +1 -1
- data/doc_out/CallbackConversationEntityListing.html.md +2 -2
- data/doc_out/CallbackConversationNotificationCallbackMediaParticipant.html.md +1 -1
- data/doc_out/CallbackConversationNotificationParticipants.html.md +1 -1
- data/doc_out/CampaignEntityListing.html.md +2 -2
- data/doc_out/CampaignNotification.html.md +2 -2
- data/doc_out/{CampaignNotificationError.html.md → CampaignNotificationRestErrorDetail.html.md} +2 -2
- data/doc_out/CampaignProgressNotification.html.md +1 -1
- data/doc_out/CampaignRuleEntityListing.html.md +2 -2
- data/doc_out/CampaignRuleNotification.html.md +1 -1
- data/doc_out/CampaignRuleNotificationCampaignRuleActionEntities.html.md +2 -2
- data/doc_out/CampaignRuleNotificationCampaignRuleEntities.html.md +2 -3
- data/doc_out/CampaignRuleNotificationUriReference.html.md +14 -0
- data/doc_out/CampaignScheduleNotification.html.md +2 -2
- data/doc_out/CampaignSequenceEntityListing.html.md +2 -2
- data/doc_out/CampaignSequenceNotification.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 +1 -1
- data/doc_out/ChatConversationNotificationParticipants.html.md +1 -1
- data/doc_out/CobrowseConversationEntityListing.html.md +2 -2
- data/doc_out/CobrowseConversationNotificationCobrowseMediaParticipant.html.md +1 -1
- data/doc_out/CobrowseConversationNotificationParticipants.html.md +1 -1
- data/doc_out/CommandStatusEntityListing.html.md +2 -2
- data/doc_out/ContactListEntityListing.html.md +2 -2
- data/doc_out/ContactListNotification.html.md +2 -2
- data/doc_out/{ContactListNotificationPhoneColumn_.html.md → ContactListNotificationContactPhoneNumberColumn.html.md} +2 -2
- data/doc_out/ContentManagementApi.html.md +153 -39
- data/doc_out/ConversationEntityListing.html.md +2 -2
- data/doc_out/ConversationsApi.html.md +421 -76
- data/doc_out/CreateEmailRequest.html.md +23 -0
- data/doc_out/CreateWebChatRequest.html.md +19 -0
- data/doc_out/DIDEntityListing.html.md +2 -2
- data/doc_out/DIDPoolEntityListing.html.md +2 -2
- data/doc_out/DecisionsFileMetadataEntityListing.html.md +2 -2
- data/doc_out/DncListEntityListing.html.md +2 -2
- data/doc_out/DncListNotification.html.md +1 -1
- data/doc_out/DocumentAuditEntityListing.html.md +2 -2
- data/doc_out/DocumentDataV2Notification.html.md +26 -0
- data/doc_out/{RecordingDataNotificationUserData.html.md → DocumentDataV2NotificationCreatedBy.html.md} +2 -2
- data/doc_out/DocumentDataV2NotificationLockData.html.md +15 -0
- data/doc_out/DocumentDataV2NotificationLockInfo.html.md +15 -0
- data/doc_out/{DocumentDataNotificationUserData.html.md → DocumentDataV2NotificationUserData.html.md} +2 -2
- data/doc_out/{DocumentDataNotificationWorkspace.html.md → DocumentDataV2NotificationWorkspace.html.md} +2 -2
- data/doc_out/{DocumentDataNotificationWorkspaceData.html.md → DocumentDataV2NotificationWorkspaceData.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/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 +2 -2
- data/doc_out/EdgeGroupEntityListing.html.md +2 -2
- data/doc_out/EdgeLineEntityListing.html.md +2 -2
- data/doc_out/EdgeRebootParameters.html.md +13 -0
- data/doc_out/EmailConversationEntityListing.html.md +2 -2
- data/doc_out/EmailConversationNotificationEmailMediaParticipant.html.md +1 -1
- data/doc_out/EmailConversationNotificationParticipants.html.md +1 -1
- 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/Entry.html.md +2 -2
- data/doc_out/EntryFeatureBoolean.html.md +14 -0
- 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/FaxApi.html.md +25 -7
- data/doc_out/FaxDataV2Notification.html.md +29 -0
- data/doc_out/FaxDataV2NotificationLockData.html.md +15 -0
- data/doc_out/FaxDataV2NotificationLockInfo.html.md +15 -0
- data/doc_out/{FaxDataNotificationUserData.html.md → FaxDataV2NotificationUserData.html.md} +2 -2
- data/doc_out/{FaxDataNotificationWorkspaceData.html.md → FaxDataV2NotificationWorkspaceData.html.md} +2 -2
- data/doc_out/FaxDocumentEntityListing.html.md +2 -2
- data/doc_out/GeolocationApi.html.md +17 -5
- data/doc_out/GreetingListing.html.md +2 -2
- data/doc_out/GreetingsApi.html.md +65 -17
- data/doc_out/GroupEntityListing.html.md +2 -2
- data/doc_out/GroupsApi.html.md +45 -12
- data/doc_out/HeartBeatAlertContainer.html.md +2 -2
- data/doc_out/HeartBeatRuleContainer.html.md +2 -2
- data/doc_out/IdentityProviderApi.html.md +89 -23
- 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 +2 -2
- data/doc_out/KeywordSetEntityListing.html.md +2 -2
- data/doc_out/LanguageEntityListing.html.md +2 -2
- data/doc_out/LanguagesApi.html.md +41 -11
- 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/LocalEncryptionConfigurationListing.html.md +2 -2
- data/doc_out/LocationsApi.html.md +17 -5
- data/doc_out/LogicalInterfaceEntityListing.html.md +2 -2
- data/doc_out/NotificationsApi.html.md +29 -8
- data/doc_out/OAuthApi.html.md +25 -7
- data/doc_out/OAuthClientEntityListing.html.md +2 -2
- data/doc_out/OAuthProviderEntityListing.html.md +2 -2
- data/doc_out/Organization.html.md +1 -0
- data/doc_out/OrganizationApi.html.md +70 -3
- 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/OutOfOfficeNotification.html.md +1 -1
- data/doc_out/OutboundApi.html.md +323 -95
- data/doc_out/OutboundRouteBaseEntityListing.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/PresenceApi.html.md +33 -9
- data/doc_out/QualityApi.html.md +128 -33
- 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/RecordingApi.html.md +133 -34
- data/doc_out/RecordingDataV2Notification.html.md +29 -0
- data/doc_out/{RecordingDataNotificationConversationData.html.md → RecordingDataV2NotificationConversationData.html.md} +2 -2
- data/doc_out/RecordingDataV2NotificationLockData.html.md +15 -0
- data/doc_out/RecordingDataV2NotificationLockInfo.html.md +15 -0
- data/doc_out/{DocumentDataNotificationCreatedBy.html.md → RecordingDataV2NotificationUserData.html.md} +2 -2
- data/doc_out/{RecordingDataNotificationWorkspaceData.html.md → RecordingDataV2NotificationWorkspaceData.html.md} +2 -2
- 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/ResponseManagementApi.html.md +45 -12
- data/doc_out/ResponseSetEntityListing.html.md +2 -2
- data/doc_out/ResponseSetNotification.html.md +1 -1
- data/doc_out/RoutingApi.html.md +193 -49
- data/doc_out/RoutingStatusAlertContainer.html.md +2 -2
- data/doc_out/RoutingStatusRuleContainer.html.md +2 -2
- data/doc_out/RuleSetEntityListing.html.md +2 -2
- data/doc_out/RuleSetNotification.html.md +1 -1
- data/doc_out/RuleSetNotificationCondition.html.md +1 -1
- data/doc_out/RuleSetNotificationConditions.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 +1 -1
- data/doc_out/ScreenShareConversationNotificationScreenShareMediaParticipant.html.md +1 -1
- data/doc_out/ScriptEntityListing.html.md +2 -2
- data/doc_out/ScriptsApi.html.md +37 -10
- data/doc_out/SearchApi.html.md +49 -13
- data/doc_out/SecurityProfileEntityListing.html.md +2 -2
- data/doc_out/SequenceScheduleNotification.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 +1 -1
- data/doc_out/SocialConversationNotificationSocialMediaParticipant.html.md +1 -1
- data/doc_out/StationEntityListing.html.md +2 -2
- data/doc_out/StationsApi.html.md +13 -4
- data/doc_out/SuggestApi.html.md +17 -5
- data/doc_out/TagValueEntityListing.html.md +2 -2
- data/doc_out/TelephonyProvidersEdgeApi.html.md +479 -121
- data/doc_out/TimeZoneEntityListing.html.md +2 -2
- data/doc_out/TokensApi.html.md +5 -2
- data/doc_out/TrunkBaseEntityListing.html.md +2 -2
- data/doc_out/TrunkEntityListing.html.md +2 -2
- data/doc_out/TrunkMetabaseEntityListing.html.md +2 -2
- data/doc_out/UserEntityListing.html.md +2 -2
- data/doc_out/UserListScheduleRequestBody.html.md +15 -0
- data/doc_out/UserPresenceAlertContainer.html.md +2 -2
- data/doc_out/UserPresenceRuleContainer.html.md +2 -2
- data/doc_out/UserQueueEntityListing.html.md +2 -2
- data/doc_out/UserRecordingEntityListing.html.md +2 -2
- data/doc_out/UserRecordingsApi.html.md +25 -7
- data/doc_out/UserSchedule.html.md +14 -0
- data/doc_out/UserScheduleActivity.html.md +18 -0
- data/doc_out/UserScheduleContainer.html.md +14 -0
- data/doc_out/UserScheduleFullDayTimeOffMarker.html.md +17 -0
- data/doc_out/UserScheduleShift.html.md +15 -0
- data/doc_out/UserSkillEntityListing.html.md +2 -2
- data/doc_out/UsersApi.html.md +169 -43
- data/doc_out/UtilitiesApi.html.md +13 -4
- data/doc_out/VideoConversationNotificationParticipants.html.md +1 -1
- data/doc_out/VideoConversationNotificationVideoMediaParticipant.html.md +1 -1
- data/doc_out/VoicemailApi.html.md +89 -23
- data/doc_out/VoicemailMessageEntityListing.html.md +2 -2
- data/doc_out/WfmUserEntityListing.html.md +13 -0
- data/doc_out/WorkforceManagementApi.html.md +227 -13
- data/doc_out/WorkspaceEntityListing.html.md +2 -2
- data/doc_out/WorkspaceMemberEntityListing.html.md +2 -2
- data/doc_out/WrapUpCodeMappingNotification.html.md +0 -1
- data/doc_out/WrapupCodeEntityListing.html.md +2 -2
- data/doc_out/index.html.md +3 -3
- data/lib/purecloud.rb +34 -20
- data/lib/purecloud/api/conversations_api.rb +120 -0
- data/lib/purecloud/api/organization_api.rb +57 -0
- data/lib/purecloud/api/outbound_api.rb +9 -9
- data/lib/purecloud/api/quality_api.rb +7 -0
- data/lib/purecloud/api/telephony_providers_edge_api.rb +3 -1
- data/lib/purecloud/api/workforce_management_api.rb +185 -3
- data/lib/purecloud/api_client.rb +1 -1
- data/lib/purecloud/models/activity_code.rb +253 -0
- data/lib/purecloud/models/activity_code_container.rb +169 -0
- data/lib/purecloud/models/agent_activity_entity_listing.rb +17 -17
- data/lib/purecloud/models/attempt_limits_entity_listing.rb +17 -17
- data/lib/purecloud/models/attempt_limits_notification.rb +24 -14
- data/lib/purecloud/models/attribute_entity_listing.rb +17 -17
- data/lib/purecloud/models/calibration_entity_listing.rb +17 -17
- data/lib/purecloud/models/call_conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/call_conversation_notification_call_media_participant.rb +1 -1
- data/lib/purecloud/models/call_conversation_notification_participants.rb +1 -1
- data/lib/purecloud/models/callable_time_set_entity_listing.rb +17 -17
- data/lib/purecloud/models/callable_time_set_notification.rb +13 -13
- data/lib/purecloud/models/callback_conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/callback_conversation_notification_callback_media_participant.rb +1 -1
- data/lib/purecloud/models/callback_conversation_notification_participants.rb +1 -1
- data/lib/purecloud/models/campaign_entity_listing.rb +17 -17
- data/lib/purecloud/models/campaign_notification.rb +15 -15
- data/lib/purecloud/models/{campaign_notification_error.rb → campaign_notification_rest_error_detail.rb} +1 -1
- data/lib/purecloud/models/campaign_progress_notification.rb +1 -1
- data/lib/purecloud/models/campaign_rule_entity_listing.rb +17 -17
- data/lib/purecloud/models/campaign_rule_notification.rb +14 -14
- data/lib/purecloud/models/campaign_rule_notification_campaign_rule_action_entities.rb +2 -2
- data/lib/purecloud/models/campaign_rule_notification_campaign_rule_entities.rb +3 -13
- data/lib/purecloud/models/campaign_rule_notification_uri_reference.rb +175 -0
- data/lib/purecloud/models/campaign_schedule_notification.rb +14 -14
- data/lib/purecloud/models/campaign_sequence_entity_listing.rb +17 -17
- data/lib/purecloud/models/campaign_sequence_notification.rb +15 -15
- data/lib/purecloud/models/certificate_authority_entity_listing.rb +17 -17
- data/lib/purecloud/models/channel_entity_listing.rb +17 -17
- data/lib/purecloud/models/chat_conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/chat_conversation_notification_chat_media_participant.rb +1 -1
- data/lib/purecloud/models/chat_conversation_notification_participants.rb +1 -1
- data/lib/purecloud/models/cobrowse_conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/cobrowse_conversation_notification_cobrowse_media_participant.rb +1 -1
- data/lib/purecloud/models/cobrowse_conversation_notification_participants.rb +1 -1
- data/lib/purecloud/models/command_status_entity_listing.rb +17 -17
- data/lib/purecloud/models/contact_list_entity_listing.rb +17 -17
- data/lib/purecloud/models/contact_list_notification.rb +14 -14
- data/lib/purecloud/models/{contact_list_notification_phone_column_.rb → contact_list_notification_contact_phone_number_column.rb} +1 -1
- data/lib/purecloud/models/contact_list_notification_import_status.rb +1 -1
- data/lib/purecloud/models/conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/create_email_request.rb +280 -0
- data/lib/purecloud/models/create_web_chat_request.rb +236 -0
- data/lib/purecloud/models/decisions_file_metadata_entity_listing.rb +17 -17
- data/lib/purecloud/models/did_entity_listing.rb +17 -17
- data/lib/purecloud/models/did_pool_entity_listing.rb +17 -17
- data/lib/purecloud/models/dnc_list_entity_listing.rb +17 -17
- data/lib/purecloud/models/dnc_list_notification.rb +14 -14
- data/lib/purecloud/models/dnc_list_notification_import_status.rb +1 -1
- data/lib/purecloud/models/document_audit_entity_listing.rb +17 -17
- data/lib/purecloud/models/{document_data_notification.rb → document_data_v2_notification.rb} +9 -29
- data/lib/purecloud/models/{recording_data_notification_user_data.rb → document_data_v2_notification_created_by.rb} +1 -1
- data/lib/purecloud/models/{document_data_notification_lock_info.rb → document_data_v2_notification_lock_data.rb} +4 -4
- data/lib/purecloud/models/{document_data_notification_lock_data.rb → document_data_v2_notification_lock_info.rb} +4 -4
- data/lib/purecloud/models/{document_data_notification_user_data.rb → document_data_v2_notification_user_data.rb} +1 -1
- data/lib/purecloud/models/{document_data_notification_workspace.rb → document_data_v2_notification_workspace.rb} +1 -1
- data/lib/purecloud/models/{document_data_notification_workspace_data.rb → document_data_v2_notification_workspace_data.rb} +1 -1
- data/lib/purecloud/models/document_entity_listing.rb +17 -17
- data/lib/purecloud/models/domain_edge_software_version_dto_entity_listing.rb +17 -17
- data/lib/purecloud/models/domain_entity_listing.rb +17 -17
- data/lib/purecloud/models/domain_entity_listing_evaluation_form.rb +17 -17
- data/lib/purecloud/models/domain_entity_listing_query_result.rb +17 -17
- 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 +17 -17
- data/lib/purecloud/models/edge_group_entity_listing.rb +17 -17
- data/lib/purecloud/models/edge_line_entity_listing.rb +17 -17
- data/lib/purecloud/models/edge_reboot_parameters.rb +166 -0
- data/lib/purecloud/models/email_conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/email_conversation_notification_email_media_participant.rb +1 -1
- data/lib/purecloud/models/email_conversation_notification_participants.rb +1 -1
- data/lib/purecloud/models/email_message_listing.rb +17 -17
- data/lib/purecloud/models/encryption_key_entity_listing.rb +17 -17
- data/lib/purecloud/models/endpoint_entity_listing.rb +17 -17
- data/lib/purecloud/models/entry.rb +8 -10
- data/lib/purecloud/models/entry_feature_boolean.rb +184 -0
- data/lib/purecloud/models/evaluation_entity_listing.rb +17 -17
- data/lib/purecloud/models/evaluation_form_entity_listing.rb +17 -17
- data/lib/purecloud/models/evaluator_activity_entity_listing.rb +17 -17
- data/lib/purecloud/models/extension_entity_listing.rb +17 -17
- data/lib/purecloud/models/extension_pool_entity_listing.rb +17 -17
- data/lib/purecloud/models/{fax_data_notification.rb → fax_data_v2_notification.rb} +9 -29
- data/lib/purecloud/models/{fax_data_notification_lock_info.rb → fax_data_v2_notification_lock_data.rb} +4 -4
- data/lib/purecloud/models/{fax_data_notification_lock_data.rb → fax_data_v2_notification_lock_info.rb} +4 -4
- data/lib/purecloud/models/{fax_data_notification_user_data.rb → fax_data_v2_notification_user_data.rb} +1 -1
- data/lib/purecloud/models/{fax_data_notification_workspace_data.rb → fax_data_v2_notification_workspace_data.rb} +1 -1
- data/lib/purecloud/models/fax_document_entity_listing.rb +17 -17
- data/lib/purecloud/models/greeting_listing.rb +17 -17
- data/lib/purecloud/models/group_entity_listing.rb +17 -17
- data/lib/purecloud/models/heart_beat_alert_container.rb +17 -17
- data/lib/purecloud/models/heart_beat_rule_container.rb +17 -17
- data/lib/purecloud/models/import_status_notification.rb +1 -1
- data/lib/purecloud/models/inbound_domain_entity_listing.rb +17 -17
- data/lib/purecloud/models/inbound_route_entity_listing.rb +17 -17
- data/lib/purecloud/models/interaction_stats_alert_container.rb +17 -17
- data/lib/purecloud/models/interaction_stats_rule_container.rb +17 -17
- data/lib/purecloud/models/json_node.rb +24 -24
- data/lib/purecloud/models/keyword_set_entity_listing.rb +17 -17
- data/lib/purecloud/models/language_entity_listing.rb +17 -17
- data/lib/purecloud/models/library_entity_listing.rb +17 -17
- data/lib/purecloud/models/line_base_entity_listing.rb +17 -17
- data/lib/purecloud/models/line_entity_listing.rb +17 -17
- data/lib/purecloud/models/local_encryption_configuration_listing.rb +17 -17
- data/lib/purecloud/models/logical_interface_entity_listing.rb +17 -17
- data/lib/purecloud/models/o_auth_client_entity_listing.rb +17 -17
- data/lib/purecloud/models/o_auth_provider_entity_listing.rb +17 -17
- data/lib/purecloud/models/organization.rb +17 -4
- data/lib/purecloud/models/organization_presence_entity_listing.rb +17 -17
- data/lib/purecloud/models/organization_role_entity_listing.rb +17 -17
- data/lib/purecloud/models/orphan_recording_listing.rb +17 -17
- data/lib/purecloud/models/out_of_office_notification.rb +1 -1
- data/lib/purecloud/models/outbound_route_base_entity_listing.rb +17 -17
- data/lib/purecloud/models/outbound_route_entity_listing.rb +17 -17
- data/lib/purecloud/models/permission_collection_entity_listing.rb +17 -17
- data/lib/purecloud/models/phone_base_entity_listing.rb +17 -17
- data/lib/purecloud/models/phone_entity_listing.rb +17 -17
- data/lib/purecloud/models/phone_meta_base_entity_listing.rb +17 -17
- data/lib/purecloud/models/physical_interface_entity_listing.rb +17 -17
- data/lib/purecloud/models/policy_entity_listing.rb +17 -17
- data/lib/purecloud/models/quality_audit_page.rb +17 -17
- data/lib/purecloud/models/queue_entity_listing.rb +17 -17
- data/lib/purecloud/models/queue_member_entity_listing.rb +17 -17
- data/lib/purecloud/models/{recording_data_notification.rb → recording_data_v2_notification.rb} +10 -30
- data/lib/purecloud/models/{recording_data_notification_conversation_data.rb → recording_data_v2_notification_conversation_data.rb} +1 -1
- data/lib/purecloud/models/recording_data_v2_notification_lock_data.rb +185 -0
- data/lib/purecloud/models/recording_data_v2_notification_lock_info.rb +185 -0
- data/lib/purecloud/models/{document_data_notification_created_by.rb → recording_data_v2_notification_user_data.rb} +1 -1
- data/lib/purecloud/models/{recording_data_notification_workspace_data.rb → recording_data_v2_notification_workspace_data.rb} +1 -1
- data/lib/purecloud/models/report_meta_data_entity_listing.rb +17 -17
- data/lib/purecloud/models/report_run_entry_entity_domain_listing.rb +17 -17
- data/lib/purecloud/models/report_schedule_entity_listing.rb +17 -17
- data/lib/purecloud/models/response_entity_list.rb +17 -17
- data/lib/purecloud/models/response_entity_listing.rb +17 -17
- data/lib/purecloud/models/response_set_entity_listing.rb +17 -17
- data/lib/purecloud/models/response_set_notification.rb +13 -13
- data/lib/purecloud/models/routing_status_alert_container.rb +17 -17
- data/lib/purecloud/models/routing_status_rule_container.rb +17 -17
- data/lib/purecloud/models/rule_set_entity_listing.rb +17 -17
- data/lib/purecloud/models/rule_set_notification.rb +1 -1
- data/lib/purecloud/models/rule_set_notification_condition.rb +11 -11
- data/lib/purecloud/models/rule_set_notification_conditions.rb +18 -18
- data/lib/purecloud/models/rule_set_notification_rule.rb +9 -0
- data/lib/purecloud/models/rule_set_notification_rules.rb +9 -0
- data/lib/purecloud/models/schema_category_entity_listing.rb +17 -17
- data/lib/purecloud/models/schema_reference_entity_listing.rb +17 -17
- data/lib/purecloud/models/screen_recording_session_listing.rb +17 -17
- data/lib/purecloud/models/screen_share_conversation_notification_participants.rb +1 -1
- data/lib/purecloud/models/screen_share_conversation_notification_screen_share_media_participant.rb +1 -1
- data/lib/purecloud/models/script_entity_listing.rb +17 -17
- data/lib/purecloud/models/security_profile_entity_listing.rb +17 -17
- data/lib/purecloud/models/sequence_schedule_notification.rb +14 -14
- data/lib/purecloud/models/share_entity_listing.rb +17 -17
- data/lib/purecloud/models/site_entity_listing.rb +17 -17
- data/lib/purecloud/models/skill_entity_listing.rb +17 -17
- data/lib/purecloud/models/social_conversation_notification_participants.rb +1 -1
- data/lib/purecloud/models/social_conversation_notification_social_media_participant.rb +1 -1
- data/lib/purecloud/models/station_entity_listing.rb +17 -17
- data/lib/purecloud/models/tag_value_entity_listing.rb +17 -17
- data/lib/purecloud/models/time_zone_entity_listing.rb +17 -17
- data/lib/purecloud/models/trunk_base_entity_listing.rb +17 -17
- data/lib/purecloud/models/trunk_entity_listing.rb +17 -17
- data/lib/purecloud/models/trunk_metabase_entity_listing.rb +17 -17
- data/lib/purecloud/models/user_entity_listing.rb +17 -17
- data/lib/purecloud/models/user_list_schedule_request_body.rb +191 -0
- data/lib/purecloud/models/user_presence_alert_container.rb +17 -17
- data/lib/purecloud/models/user_presence_rule_container.rb +17 -17
- data/lib/purecloud/models/user_queue_entity_listing.rb +17 -17
- data/lib/purecloud/models/user_recording_entity_listing.rb +17 -17
- data/lib/purecloud/models/user_schedule.rb +182 -0
- data/lib/purecloud/models/user_schedule_activity.rb +222 -0
- data/lib/purecloud/models/user_schedule_container.rb +180 -0
- data/lib/purecloud/models/user_schedule_full_day_time_off_marker.rb +211 -0
- data/lib/purecloud/models/user_schedule_shift.rb +191 -0
- data/lib/purecloud/models/user_skill_entity_listing.rb +17 -17
- data/lib/purecloud/models/video_conversation_notification_participants.rb +1 -1
- data/lib/purecloud/models/video_conversation_notification_video_media_participant.rb +1 -1
- data/lib/purecloud/models/voicemail_message_entity_listing.rb +17 -17
- data/lib/purecloud/models/wfm_user_entity_listing.rb +167 -0
- data/lib/purecloud/models/workspace_entity_listing.rb +17 -17
- data/lib/purecloud/models/workspace_member_entity_listing.rb +17 -17
- data/lib/purecloud/models/wrap_up_code_mapping_notification.rb +4 -14
- data/lib/purecloud/models/wrapup_code_entity_listing.rb +17 -17
- data/lib/purecloud/version.rb +1 -1
- data/newVersion.md +1 -1
- data/swagger.json +1 -1
- data/swagger_template/api_doc.mustache +5 -2
- data/version.json +1 -1
- metadata +70 -42
- data/doc_out/DocumentDataNotification.html.md +0 -28
- data/doc_out/DocumentDataNotificationLockData.html.md +0 -15
- data/doc_out/DocumentDataNotificationLockInfo.html.md +0 -15
- data/doc_out/FaxDataNotification.html.md +0 -31
- data/doc_out/FaxDataNotificationLockData.html.md +0 -15
- data/doc_out/FaxDataNotificationLockInfo.html.md +0 -15
- data/doc_out/RecordingDataNotification.html.md +0 -31
- data/doc_out/RecordingDataNotificationLockData.html.md +0 -15
- data/doc_out/RecordingDataNotificationLockInfo.html.md +0 -15
- data/lib/purecloud/models/recording_data_notification_lock_data.rb +0 -185
- data/lib/purecloud/models/recording_data_notification_lock_info.rb +0 -185
@@ -11,11 +11,11 @@ title: TimeZoneEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
17
18
|
| **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/TokensApi.html.md
CHANGED
@@ -6,9 +6,9 @@ title: TokensApi
|
|
6
6
|
|
7
7
|
All URIs are relative to *https://api.mypurecloud.com*
|
8
8
|
|
9
|
-
Method |
|
9
|
+
Method | Description
|
10
10
|
------------- | ------------- | -------------
|
11
|
-
|
11
|
+
[**delete_me**](TokensApi.html#delete_me) | Delete auth token used to make the request.
|
12
12
|
{: class="table table-striped"}
|
13
13
|
|
14
14
|
<a name="delete_me"></a>
|
@@ -19,6 +19,9 @@ Delete auth token used to make the request.
|
|
19
19
|
|
20
20
|
|
21
21
|
|
22
|
+
Wraps DELETE /api/v2/tokens/me
|
23
|
+
|
24
|
+
|
22
25
|
### Example
|
23
26
|
~~~ruby
|
24
27
|
# load the gem
|
@@ -11,11 +11,11 @@ title: TrunkBaseEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
17
18
|
| **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: TrunkEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
17
18
|
| **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: TrunkMetabaseEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
17
18
|
| **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: UserEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -0,0 +1,15 @@
|
|
1
|
+
---
|
2
|
+
title: UserListScheduleRequestBody
|
3
|
+
---
|
4
|
+
## PureCloud::UserListScheduleRequestBody
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **user_ids** | **Array<String>** | The user ids for which to fetch schedules | |
|
11
|
+
| **start_date** | **DateTime** | Beginning of the range of schedules to fetch, in ISO-8601 format | |
|
12
|
+
| **end_date** | **DateTime** | End of the range of schedules to fetch, in ISO-8601 format | |
|
13
|
+
{: class="table table-striped"}
|
14
|
+
|
15
|
+
|
@@ -11,11 +11,11 @@ title: UserPresenceAlertContainer
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
17
18
|
| **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: UserPresenceRuleContainer
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
17
18
|
| **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: UserQueueEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
17
18
|
| **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: UserRecordingEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -6,14 +6,14 @@ title: UserRecordingsApi
|
|
6
6
|
|
7
7
|
All URIs are relative to *https://api.mypurecloud.com*
|
8
8
|
|
9
|
-
Method |
|
9
|
+
Method | Description
|
10
10
|
------------- | ------------- | -------------
|
11
|
-
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
|
11
|
+
[**delete_recording_id**](UserRecordingsApi.html#delete_recording_id) | Delete a user recording.
|
12
|
+
[**get_recording_id**](UserRecordingsApi.html#get_recording_id) | Get a user recording.
|
13
|
+
[**get_recording_id_media**](UserRecordingsApi.html#get_recording_id_media) | Download a user recording.
|
14
|
+
[**get_summary**](UserRecordingsApi.html#get_summary) | Get user recording summary
|
15
|
+
[**get_userrecordings**](UserRecordingsApi.html#get_userrecordings) | Get a list of user recordings.
|
16
|
+
[**put_recording_id**](UserRecordingsApi.html#put_recording_id) | Update a user recording.
|
17
17
|
{: class="table table-striped"}
|
18
18
|
|
19
19
|
<a name="delete_recording_id"></a>
|
@@ -24,6 +24,9 @@ Delete a user recording.
|
|
24
24
|
|
25
25
|
|
26
26
|
|
27
|
+
Wraps DELETE /api/v2/userrecordings/{recordingId}
|
28
|
+
|
29
|
+
|
27
30
|
### Example
|
28
31
|
~~~ruby
|
29
32
|
# load the gem
|
@@ -79,6 +82,9 @@ Get a user recording.
|
|
79
82
|
|
80
83
|
|
81
84
|
|
85
|
+
Wraps GET /api/v2/userrecordings/{recordingId}
|
86
|
+
|
87
|
+
|
82
88
|
### Example
|
83
89
|
~~~ruby
|
84
90
|
# load the gem
|
@@ -139,6 +145,9 @@ Download a user recording.
|
|
139
145
|
|
140
146
|
|
141
147
|
|
148
|
+
Wraps GET /api/v2/userrecordings/{recordingId}/media
|
149
|
+
|
150
|
+
|
142
151
|
### Example
|
143
152
|
~~~ruby
|
144
153
|
# load the gem
|
@@ -199,6 +208,9 @@ Get user recording summary
|
|
199
208
|
|
200
209
|
|
201
210
|
|
211
|
+
Wraps GET /api/v2/userrecordings/summary
|
212
|
+
|
213
|
+
|
202
214
|
### Example
|
203
215
|
~~~ruby
|
204
216
|
# load the gem
|
@@ -249,6 +261,9 @@ Get a list of user recordings.
|
|
249
261
|
|
250
262
|
|
251
263
|
|
264
|
+
Wraps GET /api/v2/userrecordings
|
265
|
+
|
266
|
+
|
252
267
|
### Example
|
253
268
|
~~~ruby
|
254
269
|
# load the gem
|
@@ -310,6 +325,9 @@ Update a user recording.
|
|
310
325
|
|
311
326
|
|
312
327
|
|
328
|
+
Wraps PUT /api/v2/userrecordings/{recordingId}
|
329
|
+
|
330
|
+
|
313
331
|
### Example
|
314
332
|
~~~ruby
|
315
333
|
# load the gem
|
@@ -0,0 +1,14 @@
|
|
1
|
+
---
|
2
|
+
title: UserSchedule
|
3
|
+
---
|
4
|
+
## PureCloud::UserSchedule
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **shifts** | [**Array<UserScheduleShift>**](UserScheduleShift.html) | The shifts that belong to this schedule | [optional] |
|
11
|
+
| **full_day_time_off_markers** | [**Array<UserScheduleFullDayTimeOffMarker>**](UserScheduleFullDayTimeOffMarker.html) | Markers to indicate a full day time off request, relative to the management unit time zone | [optional] |
|
12
|
+
{: class="table table-striped"}
|
13
|
+
|
14
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
---
|
2
|
+
title: UserScheduleActivity
|
3
|
+
---
|
4
|
+
## PureCloud::UserScheduleActivity
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **activity_code_id** | **String** | The id for the activity code. Look up a map of activity codes with the activities route | [optional] |
|
11
|
+
| **start_date** | **DateTime** | Start time in UTC for this activity, in ISO-8601 format | [optional] |
|
12
|
+
| **length_in_minutes** | **Integer** | Length in minutes for this activity | [optional] |
|
13
|
+
| **description** | **String** | Description for this activity | [optional] |
|
14
|
+
| **counts_as_paid_time** | **BOOLEAN** | Whether this activity is paid | [optional] |
|
15
|
+
| **is_dst_fallback** | **BOOLEAN** | Whether this activity spans a DST fallback | [optional] |
|
16
|
+
{: class="table table-striped"}
|
17
|
+
|
18
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
---
|
2
|
+
title: UserScheduleContainer
|
3
|
+
---
|
4
|
+
## PureCloud::UserScheduleContainer
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **management_unit_time_zone** | **String** | The reference time zone used for the management unit | [optional] |
|
11
|
+
| **user_schedules** | [**Hash<String, UserSchedule>**](UserSchedule.html) | Map of user id to user schedule | [optional] |
|
12
|
+
{: class="table table-striped"}
|
13
|
+
|
14
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
---
|
2
|
+
title: UserScheduleFullDayTimeOffMarker
|
3
|
+
---
|
4
|
+
## PureCloud::UserScheduleFullDayTimeOffMarker
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **management_unit_date** | **String** | The date associated with the time off request that this marker corresponds to. Date only, in ISO-8601 format | [optional] |
|
11
|
+
| **activity_code_id** | **String** | The id for the activity code. Look up a map of activity codes with the activities route | [optional] |
|
12
|
+
| **is_paid** | **BOOLEAN** | Whether this is paid time off | [optional] |
|
13
|
+
| **length_in_minutes** | **Integer** | The length in minutes of this time off marker | [optional] |
|
14
|
+
| **description** | **String** | The description associated with the time off request that this marker corresponds to | [optional] |
|
15
|
+
{: class="table table-striped"}
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,15 @@
|
|
1
|
+
---
|
2
|
+
title: UserScheduleShift
|
3
|
+
---
|
4
|
+
## PureCloud::UserScheduleShift
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **start_date** | **DateTime** | Start time in UTC for this shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
11
|
+
| **length_in_minutes** | **Integer** | Length of this shift in minutes | [optional] |
|
12
|
+
| **activities** | [**Array<UserScheduleActivity>**](UserScheduleActivity.html) | List of activities in this shift | [optional] |
|
13
|
+
{: class="table table-striped"}
|
14
|
+
|
15
|
+
|
@@ -11,11 +11,11 @@ title: UserSkillEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **first_uri** | **String** | | [optional] |
|
15
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
17
18
|
| **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
@@ -6,50 +6,50 @@ title: UsersApi
|
|
6
6
|
|
7
7
|
All URIs are relative to *https://api.mypurecloud.com*
|
8
8
|
|
9
|
-
Method |
|
9
|
+
Method | Description
|
10
10
|
------------- | ------------- | -------------
|
11
|
-
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
|
33
|
-
|
34
|
-
|
35
|
-
|
36
|
-
|
37
|
-
|
38
|
-
|
39
|
-
|
40
|
-
|
41
|
-
|
42
|
-
|
43
|
-
|
44
|
-
|
45
|
-
|
46
|
-
|
47
|
-
|
48
|
-
|
49
|
-
|
50
|
-
|
51
|
-
|
52
|
-
|
11
|
+
[**delete_user_id**](UsersApi.html#delete_user_id) | Delete user
|
12
|
+
[**delete_user_id_roles**](UsersApi.html#delete_user_id_roles) | Removes all the roles from the user.
|
13
|
+
[**delete_user_id_routingskills_skill_id**](UsersApi.html#delete_user_id_routingskills_skill_id) | Remove routing skill from user
|
14
|
+
[**delete_user_id_station_associatedstation**](UsersApi.html#delete_user_id_station_associatedstation) | Clear associated station
|
15
|
+
[**delete_user_id_station_defaultstation**](UsersApi.html#delete_user_id_station_defaultstation) | Clear default station
|
16
|
+
[**get_fieldconfig**](UsersApi.html#get_fieldconfig) | Fetch field config for an entity type
|
17
|
+
[**get_me**](UsersApi.html#get_me) | Get current user details.
|
18
|
+
[**get_search**](UsersApi.html#get_search) | Search users using the q64 value returned from a previous search
|
19
|
+
[**get_user_id**](UsersApi.html#get_user_id) | Get user.
|
20
|
+
[**get_user_id_adjacents**](UsersApi.html#get_user_id_adjacents) | Get adjacents
|
21
|
+
[**get_user_id_callforwarding**](UsersApi.html#get_user_id_callforwarding) | Get a user's CallForwarding
|
22
|
+
[**get_user_id_directreports**](UsersApi.html#get_user_id_directreports) | Get direct reports
|
23
|
+
[**get_user_id_favorites**](UsersApi.html#get_user_id_favorites) | Get favorites
|
24
|
+
[**get_user_id_geolocations_client_id**](UsersApi.html#get_user_id_geolocations_client_id) | Get a user's Geolocation
|
25
|
+
[**get_user_id_outofoffice**](UsersApi.html#get_user_id_outofoffice) | Get a OutOfOffice
|
26
|
+
[**get_user_id_profileskills**](UsersApi.html#get_user_id_profileskills) | List profile skills for a user
|
27
|
+
[**get_user_id_queues**](UsersApi.html#get_user_id_queues) | Get queues for user
|
28
|
+
[**get_user_id_roles**](UsersApi.html#get_user_id_roles) | Returns a listing of roles and permissions for a user.
|
29
|
+
[**get_user_id_routingskills**](UsersApi.html#get_user_id_routingskills) | List routing skills for user
|
30
|
+
[**get_user_id_routingstatus**](UsersApi.html#get_user_id_routingstatus) | Fetch the routing status of a user
|
31
|
+
[**get_user_id_station**](UsersApi.html#get_user_id_station) | Get station information for user
|
32
|
+
[**get_user_id_superiors**](UsersApi.html#get_user_id_superiors) | Get superiors
|
33
|
+
[**get_users**](UsersApi.html#get_users) | Get the list of available users.
|
34
|
+
[**patch_user_id**](UsersApi.html#patch_user_id) | Update user
|
35
|
+
[**patch_user_id_callforwarding**](UsersApi.html#patch_user_id_callforwarding) | Patch a user's CallForwarding
|
36
|
+
[**patch_user_id_geolocations_client_id**](UsersApi.html#patch_user_id_geolocations_client_id) | Patch a user's Geolocation
|
37
|
+
[**patch_user_id_queues**](UsersApi.html#patch_user_id_queues) | Join or unjoin a set of queues for a user
|
38
|
+
[**patch_user_id_queues_queue_id**](UsersApi.html#patch_user_id_queues_queue_id) | Join or unjoin a queue for a user
|
39
|
+
[**post_search**](UsersApi.html#post_search) | Search users
|
40
|
+
[**post_user_id_routingskills**](UsersApi.html#post_user_id_routingskills) | Add routing skill to user
|
41
|
+
[**post_users**](UsersApi.html#post_users) | Create user
|
42
|
+
[**post_users_aggregates_query**](UsersApi.html#post_users_aggregates_query) | Query for user aggregates
|
43
|
+
[**post_users_details_query**](UsersApi.html#post_users_details_query) | Query for user details
|
44
|
+
[**post_users_observations_query**](UsersApi.html#post_users_observations_query) | Query for user observations
|
45
|
+
[**put_user_id_callforwarding**](UsersApi.html#put_user_id_callforwarding) | Update a user's CallForwarding
|
46
|
+
[**put_user_id_outofoffice**](UsersApi.html#put_user_id_outofoffice) | Update an OutOfOffice
|
47
|
+
[**put_user_id_profileskills**](UsersApi.html#put_user_id_profileskills) | Update profile skills for a user
|
48
|
+
[**put_user_id_roles**](UsersApi.html#put_user_id_roles) | Sets the user's roles
|
49
|
+
[**put_user_id_routingskills_skill_id**](UsersApi.html#put_user_id_routingskills_skill_id) | Update routing skill proficiency or state.
|
50
|
+
[**put_user_id_routingstatus**](UsersApi.html#put_user_id_routingstatus) | Update the routing status of a user
|
51
|
+
[**put_user_id_station_associatedstation_station_id**](UsersApi.html#put_user_id_station_associatedstation_station_id) | Set associated station
|
52
|
+
[**put_user_id_station_defaultstation_station_id**](UsersApi.html#put_user_id_station_defaultstation_station_id) | Set default station
|
53
53
|
{: class="table table-striped"}
|
54
54
|
|
55
55
|
<a name="delete_user_id"></a>
|
@@ -60,6 +60,9 @@ Delete user
|
|
60
60
|
|
61
61
|
|
62
62
|
|
63
|
+
Wraps DELETE /api/v2/users/{userId}
|
64
|
+
|
65
|
+
|
63
66
|
### Example
|
64
67
|
~~~ruby
|
65
68
|
# load the gem
|
@@ -116,6 +119,9 @@ Removes all the roles from the user.
|
|
116
119
|
|
117
120
|
|
118
121
|
|
122
|
+
Wraps DELETE /api/v2/users/{userId}/roles
|
123
|
+
|
124
|
+
|
119
125
|
### Example
|
120
126
|
~~~ruby
|
121
127
|
# load the gem
|
@@ -171,6 +177,9 @@ Remove routing skill from user
|
|
171
177
|
|
172
178
|
|
173
179
|
|
180
|
+
Wraps DELETE /api/v2/users/{userId}/routingskills/{skillId}
|
181
|
+
|
182
|
+
|
174
183
|
### Example
|
175
184
|
~~~ruby
|
176
185
|
# load the gem
|
@@ -230,6 +239,9 @@ Clear associated station
|
|
230
239
|
|
231
240
|
|
232
241
|
|
242
|
+
Wraps DELETE /api/v2/users/{userId}/station/associatedstation
|
243
|
+
|
244
|
+
|
233
245
|
### Example
|
234
246
|
~~~ruby
|
235
247
|
# load the gem
|
@@ -285,6 +297,9 @@ Clear default station
|
|
285
297
|
|
286
298
|
|
287
299
|
|
300
|
+
Wraps DELETE /api/v2/users/{userId}/station/defaultstation
|
301
|
+
|
302
|
+
|
288
303
|
### Example
|
289
304
|
~~~ruby
|
290
305
|
# load the gem
|
@@ -340,6 +355,9 @@ Fetch field config for an entity type
|
|
340
355
|
|
341
356
|
|
342
357
|
|
358
|
+
Wraps GET /api/v2/fieldconfig
|
359
|
+
|
360
|
+
|
343
361
|
### Example
|
344
362
|
~~~ruby
|
345
363
|
# load the gem
|
@@ -396,6 +414,9 @@ Get current user details.
|
|
396
414
|
|
397
415
|
This request is not valid when using the Client Credentials OAuth grant.
|
398
416
|
|
417
|
+
Wraps GET /api/v2/users/me
|
418
|
+
|
419
|
+
|
399
420
|
### Example
|
400
421
|
~~~ruby
|
401
422
|
# load the gem
|
@@ -453,6 +474,9 @@ Search users using the q64 value returned from a previous search
|
|
453
474
|
|
454
475
|
|
455
476
|
|
477
|
+
Wraps GET /api/v2/users/search
|
478
|
+
|
479
|
+
|
456
480
|
### Example
|
457
481
|
~~~ruby
|
458
482
|
# load the gem
|
@@ -513,6 +537,9 @@ Get user.
|
|
513
537
|
|
514
538
|
|
515
539
|
|
540
|
+
Wraps GET /api/v2/users/{userId}
|
541
|
+
|
542
|
+
|
516
543
|
### Example
|
517
544
|
~~~ruby
|
518
545
|
# load the gem
|
@@ -573,6 +600,9 @@ Get adjacents
|
|
573
600
|
|
574
601
|
|
575
602
|
|
603
|
+
Wraps GET /api/v2/users/{userId}/adjacents
|
604
|
+
|
605
|
+
|
576
606
|
### Example
|
577
607
|
~~~ruby
|
578
608
|
# load the gem
|
@@ -633,6 +663,9 @@ Get a user's CallForwarding
|
|
633
663
|
|
634
664
|
|
635
665
|
|
666
|
+
Wraps GET /api/v2/users/{userId}/callforwarding
|
667
|
+
|
668
|
+
|
636
669
|
### Example
|
637
670
|
~~~ruby
|
638
671
|
# load the gem
|
@@ -689,6 +722,9 @@ Get direct reports
|
|
689
722
|
|
690
723
|
|
691
724
|
|
725
|
+
Wraps GET /api/v2/users/{userId}/directreports
|
726
|
+
|
727
|
+
|
692
728
|
### Example
|
693
729
|
~~~ruby
|
694
730
|
# load the gem
|
@@ -749,6 +785,9 @@ Get favorites
|
|
749
785
|
|
750
786
|
|
751
787
|
|
788
|
+
Wraps GET /api/v2/users/{userId}/favorites
|
789
|
+
|
790
|
+
|
752
791
|
### Example
|
753
792
|
~~~ruby
|
754
793
|
# load the gem
|
@@ -815,6 +854,9 @@ Get a user's Geolocation
|
|
815
854
|
|
816
855
|
|
817
856
|
|
857
|
+
Wraps GET /api/v2/users/{userId}/geolocations/{clientId}
|
858
|
+
|
859
|
+
|
818
860
|
### Example
|
819
861
|
~~~ruby
|
820
862
|
# load the gem
|
@@ -874,6 +916,9 @@ Get a OutOfOffice
|
|
874
916
|
|
875
917
|
|
876
918
|
|
919
|
+
Wraps GET /api/v2/users/{userId}/outofoffice
|
920
|
+
|
921
|
+
|
877
922
|
### Example
|
878
923
|
~~~ruby
|
879
924
|
# load the gem
|
@@ -930,6 +975,9 @@ List profile skills for a user
|
|
930
975
|
|
931
976
|
|
932
977
|
|
978
|
+
Wraps GET /api/v2/users/{userId}/profileskills
|
979
|
+
|
980
|
+
|
933
981
|
### Example
|
934
982
|
~~~ruby
|
935
983
|
# load the gem
|
@@ -986,6 +1034,9 @@ Get queues for user
|
|
986
1034
|
|
987
1035
|
|
988
1036
|
|
1037
|
+
Wraps GET /api/v2/users/{userId}/queues
|
1038
|
+
|
1039
|
+
|
989
1040
|
### Example
|
990
1041
|
~~~ruby
|
991
1042
|
# load the gem
|
@@ -1050,6 +1101,9 @@ Returns a listing of roles and permissions for a user.
|
|
1050
1101
|
|
1051
1102
|
|
1052
1103
|
|
1104
|
+
Wraps GET /api/v2/users/{userId}/roles
|
1105
|
+
|
1106
|
+
|
1053
1107
|
### Example
|
1054
1108
|
~~~ruby
|
1055
1109
|
# load the gem
|
@@ -1106,6 +1160,9 @@ List routing skills for user
|
|
1106
1160
|
|
1107
1161
|
|
1108
1162
|
|
1163
|
+
Wraps GET /api/v2/users/{userId}/routingskills
|
1164
|
+
|
1165
|
+
|
1109
1166
|
### Example
|
1110
1167
|
~~~ruby
|
1111
1168
|
# load the gem
|
@@ -1170,6 +1227,9 @@ Fetch the routing status of a user
|
|
1170
1227
|
|
1171
1228
|
|
1172
1229
|
|
1230
|
+
Wraps GET /api/v2/users/{userId}/routingstatus
|
1231
|
+
|
1232
|
+
|
1173
1233
|
### Example
|
1174
1234
|
~~~ruby
|
1175
1235
|
# load the gem
|
@@ -1226,6 +1286,9 @@ Get station information for user
|
|
1226
1286
|
|
1227
1287
|
|
1228
1288
|
|
1289
|
+
Wraps GET /api/v2/users/{userId}/station
|
1290
|
+
|
1291
|
+
|
1229
1292
|
### Example
|
1230
1293
|
~~~ruby
|
1231
1294
|
# load the gem
|
@@ -1282,6 +1345,9 @@ Get superiors
|
|
1282
1345
|
|
1283
1346
|
|
1284
1347
|
|
1348
|
+
Wraps GET /api/v2/users/{userId}/superiors
|
1349
|
+
|
1350
|
+
|
1285
1351
|
### Example
|
1286
1352
|
~~~ruby
|
1287
1353
|
# load the gem
|
@@ -1342,6 +1408,9 @@ Get the list of available users.
|
|
1342
1408
|
|
1343
1409
|
|
1344
1410
|
|
1411
|
+
Wraps GET /api/v2/users
|
1412
|
+
|
1413
|
+
|
1345
1414
|
### Example
|
1346
1415
|
~~~ruby
|
1347
1416
|
# load the gem
|
@@ -1407,6 +1476,9 @@ Update user
|
|
1407
1476
|
|
1408
1477
|
|
1409
1478
|
|
1479
|
+
Wraps PATCH /api/v2/users/{userId}
|
1480
|
+
|
1481
|
+
|
1410
1482
|
### Example
|
1411
1483
|
~~~ruby
|
1412
1484
|
# load the gem
|
@@ -1466,6 +1538,9 @@ Patch a user's CallForwarding
|
|
1466
1538
|
|
1467
1539
|
|
1468
1540
|
|
1541
|
+
Wraps PATCH /api/v2/users/{userId}/callforwarding
|
1542
|
+
|
1543
|
+
|
1469
1544
|
### Example
|
1470
1545
|
~~~ruby
|
1471
1546
|
# load the gem
|
@@ -1525,6 +1600,9 @@ Patch a user's Geolocation
|
|
1525
1600
|
|
1526
1601
|
The geolocation object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the client as the user's primary geolocation source. Option 2: Provide the 'latitude' and 'longitude' values. This will enqueue an asynchronous update of the 'city', 'region', and 'country', generating a notification. A subsequent GET operation will include the new values for 'city', 'region' and 'country'. Option 3: Provide the 'city', 'region', 'country' values. Option 1 can be combined with Option 2 or Option 3. For example, update the client as primary and provide latitude and longitude values.
|
1527
1602
|
|
1603
|
+
Wraps PATCH /api/v2/users/{userId}/geolocations/{clientId}
|
1604
|
+
|
1605
|
+
|
1528
1606
|
### Example
|
1529
1607
|
~~~ruby
|
1530
1608
|
# load the gem
|
@@ -1587,6 +1665,9 @@ Join or unjoin a set of queues for a user
|
|
1587
1665
|
|
1588
1666
|
|
1589
1667
|
|
1668
|
+
Wraps PATCH /api/v2/users/{userId}/queues
|
1669
|
+
|
1670
|
+
|
1590
1671
|
### Example
|
1591
1672
|
~~~ruby
|
1592
1673
|
# load the gem
|
@@ -1646,6 +1727,9 @@ Join or unjoin a queue for a user
|
|
1646
1727
|
|
1647
1728
|
|
1648
1729
|
|
1730
|
+
Wraps PATCH /api/v2/users/{userId}/queues/{queueId}
|
1731
|
+
|
1732
|
+
|
1649
1733
|
### Example
|
1650
1734
|
~~~ruby
|
1651
1735
|
# load the gem
|
@@ -1708,6 +1792,9 @@ Search users
|
|
1708
1792
|
|
1709
1793
|
|
1710
1794
|
|
1795
|
+
Wraps POST /api/v2/users/search
|
1796
|
+
|
1797
|
+
|
1711
1798
|
### Example
|
1712
1799
|
~~~ruby
|
1713
1800
|
# load the gem
|
@@ -1764,6 +1851,9 @@ Add routing skill to user
|
|
1764
1851
|
|
1765
1852
|
|
1766
1853
|
|
1854
|
+
Wraps POST /api/v2/users/{userId}/routingskills
|
1855
|
+
|
1856
|
+
|
1767
1857
|
### Example
|
1768
1858
|
~~~ruby
|
1769
1859
|
# load the gem
|
@@ -1823,6 +1913,9 @@ Create user
|
|
1823
1913
|
|
1824
1914
|
|
1825
1915
|
|
1916
|
+
Wraps POST /api/v2/users
|
1917
|
+
|
1918
|
+
|
1826
1919
|
### Example
|
1827
1920
|
~~~ruby
|
1828
1921
|
# load the gem
|
@@ -1879,6 +1972,9 @@ Query for user aggregates
|
|
1879
1972
|
|
1880
1973
|
|
1881
1974
|
|
1975
|
+
Wraps POST /api/v2/analytics/users/aggregates/query
|
1976
|
+
|
1977
|
+
|
1882
1978
|
### Example
|
1883
1979
|
~~~ruby
|
1884
1980
|
# load the gem
|
@@ -1935,6 +2031,9 @@ Query for user details
|
|
1935
2031
|
|
1936
2032
|
|
1937
2033
|
|
2034
|
+
Wraps POST /api/v2/analytics/users/details/query
|
2035
|
+
|
2036
|
+
|
1938
2037
|
### Example
|
1939
2038
|
~~~ruby
|
1940
2039
|
# load the gem
|
@@ -1991,6 +2090,9 @@ Query for user observations
|
|
1991
2090
|
|
1992
2091
|
|
1993
2092
|
|
2093
|
+
Wraps POST /api/v2/analytics/users/observations/query
|
2094
|
+
|
2095
|
+
|
1994
2096
|
### Example
|
1995
2097
|
~~~ruby
|
1996
2098
|
# load the gem
|
@@ -2047,6 +2149,9 @@ Update a user's CallForwarding
|
|
2047
2149
|
|
2048
2150
|
|
2049
2151
|
|
2152
|
+
Wraps PUT /api/v2/users/{userId}/callforwarding
|
2153
|
+
|
2154
|
+
|
2050
2155
|
### Example
|
2051
2156
|
~~~ruby
|
2052
2157
|
# load the gem
|
@@ -2106,6 +2211,9 @@ Update an OutOfOffice
|
|
2106
2211
|
|
2107
2212
|
|
2108
2213
|
|
2214
|
+
Wraps PUT /api/v2/users/{userId}/outofoffice
|
2215
|
+
|
2216
|
+
|
2109
2217
|
### Example
|
2110
2218
|
~~~ruby
|
2111
2219
|
# load the gem
|
@@ -2165,6 +2273,9 @@ Update profile skills for a user
|
|
2165
2273
|
|
2166
2274
|
|
2167
2275
|
|
2276
|
+
Wraps PUT /api/v2/users/{userId}/profileskills
|
2277
|
+
|
2278
|
+
|
2168
2279
|
### Example
|
2169
2280
|
~~~ruby
|
2170
2281
|
# load the gem
|
@@ -2225,6 +2336,9 @@ Sets the user's roles
|
|
2225
2336
|
|
2226
2337
|
|
2227
2338
|
|
2339
|
+
Wraps PUT /api/v2/users/{userId}/roles
|
2340
|
+
|
2341
|
+
|
2228
2342
|
### Example
|
2229
2343
|
~~~ruby
|
2230
2344
|
# load the gem
|
@@ -2284,6 +2398,9 @@ Update routing skill proficiency or state.
|
|
2284
2398
|
|
2285
2399
|
|
2286
2400
|
|
2401
|
+
Wraps PUT /api/v2/users/{userId}/routingskills/{skillId}
|
2402
|
+
|
2403
|
+
|
2287
2404
|
### Example
|
2288
2405
|
~~~ruby
|
2289
2406
|
# load the gem
|
@@ -2346,6 +2463,9 @@ Update the routing status of a user
|
|
2346
2463
|
|
2347
2464
|
|
2348
2465
|
|
2466
|
+
Wraps PUT /api/v2/users/{userId}/routingstatus
|
2467
|
+
|
2468
|
+
|
2349
2469
|
### Example
|
2350
2470
|
~~~ruby
|
2351
2471
|
# load the gem
|
@@ -2405,6 +2525,9 @@ Set associated station
|
|
2405
2525
|
|
2406
2526
|
|
2407
2527
|
|
2528
|
+
Wraps PUT /api/v2/users/{userId}/station/associatedstation/{stationId}
|
2529
|
+
|
2530
|
+
|
2408
2531
|
### Example
|
2409
2532
|
~~~ruby
|
2410
2533
|
# load the gem
|
@@ -2463,6 +2586,9 @@ Set default station
|
|
2463
2586
|
|
2464
2587
|
|
2465
2588
|
|
2589
|
+
Wraps PUT /api/v2/users/{userId}/station/defaultstation/{stationId}
|
2590
|
+
|
2591
|
+
|
2466
2592
|
### Example
|
2467
2593
|
~~~ruby
|
2468
2594
|
# load the gem
|