purecloud 0.67.1 → 0.68.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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
|
@@ -6,11 +6,11 @@ title: UtilitiesApi
|
|
|
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
|
-
|
|
11
|
+
[**get_date**](UtilitiesApi.html#get_date) | Get the current system date/time
|
|
12
|
+
[**get_timezones**](UtilitiesApi.html#get_timezones) | Get time zones list
|
|
13
|
+
[**post_details**](UtilitiesApi.html#post_details) | Returns the information about an X509 PEM encoded certificate or certificate chain.
|
|
14
14
|
{: class="table table-striped"}
|
|
15
15
|
|
|
16
16
|
<a name="get_date"></a>
|
|
@@ -21,6 +21,9 @@ Get the current system date/time
|
|
|
21
21
|
|
|
22
22
|
|
|
23
23
|
|
|
24
|
+
Wraps GET /api/v2/date
|
|
25
|
+
|
|
26
|
+
|
|
24
27
|
### Example
|
|
25
28
|
~~~ruby
|
|
26
29
|
# load the gem
|
|
@@ -71,6 +74,9 @@ Get time zones list
|
|
|
71
74
|
|
|
72
75
|
|
|
73
76
|
|
|
77
|
+
Wraps GET /api/v2/timezones
|
|
78
|
+
|
|
79
|
+
|
|
74
80
|
### Example
|
|
75
81
|
~~~ruby
|
|
76
82
|
# load the gem
|
|
@@ -130,6 +136,9 @@ Returns the information about an X509 PEM encoded certificate or certificate cha
|
|
|
130
136
|
|
|
131
137
|
|
|
132
138
|
|
|
139
|
+
Wraps POST /api/v2/certificate/details
|
|
140
|
+
|
|
141
|
+
|
|
133
142
|
### Example
|
|
134
143
|
~~~ruby
|
|
135
144
|
# load the gem
|
|
@@ -35,7 +35,7 @@ title: VideoConversationNotificationParticipants
|
|
|
35
35
|
| **start_hold_time** | **DateTime** | | [optional] |
|
|
36
36
|
| **attributes** | **Hash<String, String>** | | [optional] |
|
|
37
37
|
| **sharing_screen** | **BOOLEAN** | | [optional] |
|
|
38
|
-
| **user** | [**
|
|
38
|
+
| **user** | [**DocumentDataV2NotificationCreatedBy**](DocumentDataV2NotificationCreatedBy.html) | | [optional] |
|
|
39
39
|
{: class="table table-striped"}
|
|
40
40
|
|
|
41
41
|
|
|
@@ -21,7 +21,7 @@ title: VideoConversationNotificationVideoMediaParticipant
|
|
|
21
21
|
| **held** | **BOOLEAN** | | [optional] |
|
|
22
22
|
| **wrapup_required** | **BOOLEAN** | | [optional] |
|
|
23
23
|
| **wrapup_prompt** | **String** | | [optional] |
|
|
24
|
-
| **user** | [**
|
|
24
|
+
| **user** | [**DocumentDataV2NotificationCreatedBy**](DocumentDataV2NotificationCreatedBy.html) | | [optional] |
|
|
25
25
|
| **queue** | [**VideoConversationNotificationUriReference**](VideoConversationNotificationUriReference.html) | | [optional] |
|
|
26
26
|
| **attributes** | **Hash<String, String>** | | [optional] |
|
|
27
27
|
| **error_info** | [**VideoConversationNotificationErrorInfo**](VideoConversationNotificationErrorInfo.html) | | [optional] |
|
|
@@ -6,30 +6,30 @@ title: VoicemailApi
|
|
|
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
|
-
|
|
11
|
+
[**delete_messages**](VoicemailApi.html#delete_messages) | Delete all voicemail messages
|
|
12
|
+
[**delete_messages_message_id**](VoicemailApi.html#delete_messages_message_id) | Delete a message.
|
|
13
|
+
[**get_groups_group_id_mailbox**](VoicemailApi.html#get_groups_group_id_mailbox) | Get the group's mailbox information
|
|
14
|
+
[**get_groups_group_id_messages**](VoicemailApi.html#get_groups_group_id_messages) | List voicemail messages
|
|
15
|
+
[**get_groups_group_id_policy**](VoicemailApi.html#get_groups_group_id_policy) | Get a group's voicemail policy
|
|
16
|
+
[**get_mailbox**](VoicemailApi.html#get_mailbox) | Get the current user's mailbox information
|
|
17
|
+
[**get_me_mailbox**](VoicemailApi.html#get_me_mailbox) | Get the current user's mailbox information
|
|
18
|
+
[**get_me_messages**](VoicemailApi.html#get_me_messages) | List voicemail messages
|
|
19
|
+
[**get_me_policy**](VoicemailApi.html#get_me_policy) | Get the current user's voicemail policy
|
|
20
|
+
[**get_messages**](VoicemailApi.html#get_messages) | List voicemail messages
|
|
21
|
+
[**get_messages_message_id**](VoicemailApi.html#get_messages_message_id) | Get message.
|
|
22
|
+
[**get_messages_message_id_media**](VoicemailApi.html#get_messages_message_id_media) | Get media playback URI for this message
|
|
23
|
+
[**get_policy**](VoicemailApi.html#get_policy) | Get a policy
|
|
24
|
+
[**get_search**](VoicemailApi.html#get_search) | Search voicemails using the q64 value returned from a previous search
|
|
25
|
+
[**get_userpolicies_user_id**](VoicemailApi.html#get_userpolicies_user_id) | Get a user's voicemail policy
|
|
26
|
+
[**patch_groups_group_id_policy**](VoicemailApi.html#patch_groups_group_id_policy) | Update a group's voicemail policy
|
|
27
|
+
[**patch_me_policy**](VoicemailApi.html#patch_me_policy) | Update the current user's voicemail policy
|
|
28
|
+
[**patch_userpolicies_user_id**](VoicemailApi.html#patch_userpolicies_user_id) | Update a user's voicemail policy
|
|
29
|
+
[**post_messages**](VoicemailApi.html#post_messages) | Copy a voicemail message to a user or group
|
|
30
|
+
[**post_search**](VoicemailApi.html#post_search) | Search voicemails
|
|
31
|
+
[**put_messages_message_id**](VoicemailApi.html#put_messages_message_id) | Update a message.
|
|
32
|
+
[**put_policy**](VoicemailApi.html#put_policy) | Update a policy
|
|
33
33
|
{: class="table table-striped"}
|
|
34
34
|
|
|
35
35
|
<a name="delete_messages"></a>
|
|
@@ -40,6 +40,9 @@ Delete all voicemail messages
|
|
|
40
40
|
|
|
41
41
|
|
|
42
42
|
|
|
43
|
+
Wraps DELETE /api/v2/voicemail/messages
|
|
44
|
+
|
|
45
|
+
|
|
43
46
|
### Example
|
|
44
47
|
~~~ruby
|
|
45
48
|
# load the gem
|
|
@@ -90,6 +93,9 @@ Delete a message.
|
|
|
90
93
|
|
|
91
94
|
|
|
92
95
|
|
|
96
|
+
Wraps DELETE /api/v2/voicemail/messages/{messageId}
|
|
97
|
+
|
|
98
|
+
|
|
93
99
|
### Example
|
|
94
100
|
~~~ruby
|
|
95
101
|
# load the gem
|
|
@@ -146,6 +152,9 @@ Get the group's mailbox information
|
|
|
146
152
|
|
|
147
153
|
|
|
148
154
|
|
|
155
|
+
Wraps GET /api/v2/voicemail/groups/{groupId}/mailbox
|
|
156
|
+
|
|
157
|
+
|
|
149
158
|
### Example
|
|
150
159
|
~~~ruby
|
|
151
160
|
# load the gem
|
|
@@ -202,6 +211,9 @@ List voicemail messages
|
|
|
202
211
|
|
|
203
212
|
|
|
204
213
|
|
|
214
|
+
Wraps GET /api/v2/voicemail/groups/{groupId}/messages
|
|
215
|
+
|
|
216
|
+
|
|
205
217
|
### Example
|
|
206
218
|
~~~ruby
|
|
207
219
|
# load the gem
|
|
@@ -264,6 +276,9 @@ Get a group's voicemail policy
|
|
|
264
276
|
|
|
265
277
|
|
|
266
278
|
|
|
279
|
+
Wraps GET /api/v2/voicemail/groups/{groupId}/policy
|
|
280
|
+
|
|
281
|
+
|
|
267
282
|
### Example
|
|
268
283
|
~~~ruby
|
|
269
284
|
# load the gem
|
|
@@ -320,6 +335,9 @@ Get the current user's mailbox information
|
|
|
320
335
|
|
|
321
336
|
|
|
322
337
|
|
|
338
|
+
Wraps GET /api/v2/voicemail/mailbox
|
|
339
|
+
|
|
340
|
+
|
|
323
341
|
### Example
|
|
324
342
|
~~~ruby
|
|
325
343
|
# load the gem
|
|
@@ -370,6 +388,9 @@ Get the current user's mailbox information
|
|
|
370
388
|
|
|
371
389
|
|
|
372
390
|
|
|
391
|
+
Wraps GET /api/v2/voicemail/me/mailbox
|
|
392
|
+
|
|
393
|
+
|
|
373
394
|
### Example
|
|
374
395
|
~~~ruby
|
|
375
396
|
# load the gem
|
|
@@ -420,6 +441,9 @@ List voicemail messages
|
|
|
420
441
|
|
|
421
442
|
|
|
422
443
|
|
|
444
|
+
Wraps GET /api/v2/voicemail/me/messages
|
|
445
|
+
|
|
446
|
+
|
|
423
447
|
### Example
|
|
424
448
|
~~~ruby
|
|
425
449
|
# load the gem
|
|
@@ -479,6 +503,9 @@ Get the current user's voicemail policy
|
|
|
479
503
|
|
|
480
504
|
|
|
481
505
|
|
|
506
|
+
Wraps GET /api/v2/voicemail/me/policy
|
|
507
|
+
|
|
508
|
+
|
|
482
509
|
### Example
|
|
483
510
|
~~~ruby
|
|
484
511
|
# load the gem
|
|
@@ -529,6 +556,9 @@ List voicemail messages
|
|
|
529
556
|
|
|
530
557
|
|
|
531
558
|
|
|
559
|
+
Wraps GET /api/v2/voicemail/messages
|
|
560
|
+
|
|
561
|
+
|
|
532
562
|
### Example
|
|
533
563
|
~~~ruby
|
|
534
564
|
# load the gem
|
|
@@ -588,6 +618,9 @@ Get message.
|
|
|
588
618
|
|
|
589
619
|
|
|
590
620
|
|
|
621
|
+
Wraps GET /api/v2/voicemail/messages/{messageId}
|
|
622
|
+
|
|
623
|
+
|
|
591
624
|
### Example
|
|
592
625
|
~~~ruby
|
|
593
626
|
# load the gem
|
|
@@ -648,6 +681,9 @@ Get media playback URI for this message
|
|
|
648
681
|
|
|
649
682
|
|
|
650
683
|
|
|
684
|
+
Wraps GET /api/v2/voicemail/messages/{messageId}/media
|
|
685
|
+
|
|
686
|
+
|
|
651
687
|
### Example
|
|
652
688
|
~~~ruby
|
|
653
689
|
# load the gem
|
|
@@ -708,6 +744,9 @@ Get a policy
|
|
|
708
744
|
|
|
709
745
|
|
|
710
746
|
|
|
747
|
+
Wraps GET /api/v2/voicemail/policy
|
|
748
|
+
|
|
749
|
+
|
|
711
750
|
### Example
|
|
712
751
|
~~~ruby
|
|
713
752
|
# load the gem
|
|
@@ -758,6 +797,9 @@ Search voicemails using the q64 value returned from a previous search
|
|
|
758
797
|
|
|
759
798
|
|
|
760
799
|
|
|
800
|
+
Wraps GET /api/v2/voicemail/search
|
|
801
|
+
|
|
802
|
+
|
|
761
803
|
### Example
|
|
762
804
|
~~~ruby
|
|
763
805
|
# load the gem
|
|
@@ -818,6 +860,9 @@ Get a user's voicemail policy
|
|
|
818
860
|
|
|
819
861
|
|
|
820
862
|
|
|
863
|
+
Wraps GET /api/v2/voicemail/userpolicies/{userId}
|
|
864
|
+
|
|
865
|
+
|
|
821
866
|
### Example
|
|
822
867
|
~~~ruby
|
|
823
868
|
# load the gem
|
|
@@ -874,6 +919,9 @@ Update a group's voicemail policy
|
|
|
874
919
|
|
|
875
920
|
|
|
876
921
|
|
|
922
|
+
Wraps PATCH /api/v2/voicemail/groups/{groupId}/policy
|
|
923
|
+
|
|
924
|
+
|
|
877
925
|
### Example
|
|
878
926
|
~~~ruby
|
|
879
927
|
# load the gem
|
|
@@ -933,6 +981,9 @@ Update the current user's voicemail policy
|
|
|
933
981
|
|
|
934
982
|
|
|
935
983
|
|
|
984
|
+
Wraps PATCH /api/v2/voicemail/me/policy
|
|
985
|
+
|
|
986
|
+
|
|
936
987
|
### Example
|
|
937
988
|
~~~ruby
|
|
938
989
|
# load the gem
|
|
@@ -989,6 +1040,9 @@ Update a user's voicemail policy
|
|
|
989
1040
|
|
|
990
1041
|
|
|
991
1042
|
|
|
1043
|
+
Wraps PATCH /api/v2/voicemail/userpolicies/{userId}
|
|
1044
|
+
|
|
1045
|
+
|
|
992
1046
|
### Example
|
|
993
1047
|
~~~ruby
|
|
994
1048
|
# load the gem
|
|
@@ -1048,6 +1102,9 @@ Copy a voicemail message to a user or group
|
|
|
1048
1102
|
|
|
1049
1103
|
|
|
1050
1104
|
|
|
1105
|
+
Wraps POST /api/v2/voicemail/messages
|
|
1106
|
+
|
|
1107
|
+
|
|
1051
1108
|
### Example
|
|
1052
1109
|
~~~ruby
|
|
1053
1110
|
# load the gem
|
|
@@ -1105,6 +1162,9 @@ Search voicemails
|
|
|
1105
1162
|
|
|
1106
1163
|
|
|
1107
1164
|
|
|
1165
|
+
Wraps POST /api/v2/voicemail/search
|
|
1166
|
+
|
|
1167
|
+
|
|
1108
1168
|
### Example
|
|
1109
1169
|
~~~ruby
|
|
1110
1170
|
# load the gem
|
|
@@ -1161,6 +1221,9 @@ Update a message.
|
|
|
1161
1221
|
|
|
1162
1222
|
|
|
1163
1223
|
|
|
1224
|
+
Wraps PUT /api/v2/voicemail/messages/{messageId}
|
|
1225
|
+
|
|
1226
|
+
|
|
1164
1227
|
### Example
|
|
1165
1228
|
~~~ruby
|
|
1166
1229
|
# load the gem
|
|
@@ -1220,6 +1283,9 @@ Update a policy
|
|
|
1220
1283
|
|
|
1221
1284
|
|
|
1222
1285
|
|
|
1286
|
+
Wraps PUT /api/v2/voicemail/policy
|
|
1287
|
+
|
|
1288
|
+
|
|
1223
1289
|
### Example
|
|
1224
1290
|
~~~ruby
|
|
1225
1291
|
# load the gem
|
|
@@ -11,11 +11,11 @@ title: VoicemailMessageEntityListing
|
|
|
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,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: WfmUserEntityListing
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::WfmUserEntityListing
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **entities** | [**Array<User>**](User.html) | | [optional] |
|
|
11
|
+
{: class="table table-striped"}
|
|
12
|
+
|
|
13
|
+
|
|
@@ -6,18 +6,21 @@ title: WorkforceManagementApi
|
|
|
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
|
-
|
|
11
|
+
[**get_adherence**](WorkforceManagementApi.html#get_adherence) | Get a list of UserScheduleAdherence records for the requested users
|
|
12
|
+
[**get_decisions_downloads_download_id**](WorkforceManagementApi.html#get_decisions_downloads_download_id) | Get decisions download link
|
|
13
|
+
[**get_managementunits_mu_id_activitycodes**](WorkforceManagementApi.html#get_managementunits_mu_id_activitycodes) | Get activity codes corresponding to a management unit
|
|
14
|
+
[**get_managementunits_mu_id_users**](WorkforceManagementApi.html#get_managementunits_mu_id_users) | Get agents in the management unit
|
|
15
|
+
[**get_managementunits_mu_id_users_user_id_timeoffrequests**](WorkforceManagementApi.html#get_managementunits_mu_id_users_user_id_timeoffrequests) | Get a list of time off requests for any user
|
|
16
|
+
[**get_managementunits_mu_id_users_user_id_timeoffrequests_timeoffrequest_id**](WorkforceManagementApi.html#get_managementunits_mu_id_users_user_id_timeoffrequests_timeoffrequest_id) | Get a time off request by id
|
|
17
|
+
[**get_timeoffrequests**](WorkforceManagementApi.html#get_timeoffrequests) | Get a list of time off requests for the current user
|
|
18
|
+
[**get_timeoffrequests_timeoffrequest_id**](WorkforceManagementApi.html#get_timeoffrequests_timeoffrequest_id) | Get a time off request for the current user by id
|
|
19
|
+
[**patch_timeoffrequests_timeoffrequest_id**](WorkforceManagementApi.html#patch_timeoffrequests_timeoffrequest_id) | Mark a time off request for the current user as read or unread
|
|
20
|
+
[**post_decisions_downloads_search**](WorkforceManagementApi.html#post_decisions_downloads_search) | Download decisions files metadata
|
|
21
|
+
[**post_longtermforecasts**](WorkforceManagementApi.html#post_longtermforecasts) | Create a forecast
|
|
22
|
+
[**post_managementunits_mu_id_schedules_search**](WorkforceManagementApi.html#post_managementunits_mu_id_schedules_search) | Get user schedules within the given time range
|
|
23
|
+
[**post_schedules**](WorkforceManagementApi.html#post_schedules) | Get a schedule for the current user
|
|
21
24
|
{: class="table table-striped"}
|
|
22
25
|
|
|
23
26
|
<a name="get_adherence"></a>
|
|
@@ -28,6 +31,9 @@ Get a list of UserScheduleAdherence records for the requested users
|
|
|
28
31
|
|
|
29
32
|
|
|
30
33
|
|
|
34
|
+
Wraps GET /api/v2/workforcemanagement/adherence
|
|
35
|
+
|
|
36
|
+
|
|
31
37
|
### Example
|
|
32
38
|
~~~ruby
|
|
33
39
|
# load the gem
|
|
@@ -84,6 +90,9 @@ Get decisions download link
|
|
|
84
90
|
|
|
85
91
|
|
|
86
92
|
|
|
93
|
+
Wraps GET /api/v2/workforcemanagement/decisions/downloads/{downloadId}
|
|
94
|
+
|
|
95
|
+
|
|
87
96
|
### Example
|
|
88
97
|
~~~ruby
|
|
89
98
|
# load the gem
|
|
@@ -136,6 +145,124 @@ Name | Type | Description | Notes
|
|
|
136
145
|
|
|
137
146
|
|
|
138
147
|
|
|
148
|
+
<a name="get_managementunits_mu_id_activitycodes"></a>
|
|
149
|
+
|
|
150
|
+
## -[**ActivityCodeContainer**](ActivityCodeContainer.html) get_managementunits_mu_id_activitycodes(mu_id)
|
|
151
|
+
|
|
152
|
+
Get activity codes corresponding to a management unit
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
Wraps GET /api/v2/workforcemanagement/managementunits/{muId}/activitycodes
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
### Example
|
|
160
|
+
~~~ruby
|
|
161
|
+
# load the gem
|
|
162
|
+
require 'purecloud'
|
|
163
|
+
# setup authorization
|
|
164
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
165
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
166
|
+
environment = "mypurecloud.com"
|
|
167
|
+
|
|
168
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
169
|
+
|
|
170
|
+
PureCloud.configure do |config|
|
|
171
|
+
config.access_token = @authToken
|
|
172
|
+
end
|
|
173
|
+
|
|
174
|
+
api_instance = PureCloud::WorkforceManagementApi.new
|
|
175
|
+
|
|
176
|
+
mu_id = "mu_id_example" # String | The muId of the management unit.
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
begin
|
|
180
|
+
#Get activity codes corresponding to a management unit
|
|
181
|
+
result = api_instance.get_managementunits_mu_id_activitycodes(mu_id)
|
|
182
|
+
p result
|
|
183
|
+
rescue PureCloud::ApiError => e
|
|
184
|
+
puts "Exception when calling WorkforceManagementApi->get_managementunits_mu_id_activitycodes: #{e}"
|
|
185
|
+
end
|
|
186
|
+
~~~
|
|
187
|
+
|
|
188
|
+
### Parameters
|
|
189
|
+
|
|
190
|
+
Name | Type | Description | Notes
|
|
191
|
+
------------- | ------------- | ------------- | -------------
|
|
192
|
+
**mu_id** | **String**| The muId of the management unit. |
|
|
193
|
+
{: class="table table-striped"}
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
### Return type
|
|
197
|
+
|
|
198
|
+
[**ActivityCodeContainer**](ActivityCodeContainer.html)
|
|
199
|
+
|
|
200
|
+
### HTTP request headers
|
|
201
|
+
|
|
202
|
+
- **Content-Type**: application/json
|
|
203
|
+
- **Accept**: application/json
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
<a name="get_managementunits_mu_id_users"></a>
|
|
208
|
+
|
|
209
|
+
## -[**WfmUserEntityListing**](WfmUserEntityListing.html) get_managementunits_mu_id_users(mu_id)
|
|
210
|
+
|
|
211
|
+
Get agents in the management unit
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
Wraps GET /api/v2/workforcemanagement/managementunits/{muId}/users
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
### Example
|
|
219
|
+
~~~ruby
|
|
220
|
+
# load the gem
|
|
221
|
+
require 'purecloud'
|
|
222
|
+
# setup authorization
|
|
223
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
224
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
225
|
+
environment = "mypurecloud.com"
|
|
226
|
+
|
|
227
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
228
|
+
|
|
229
|
+
PureCloud.configure do |config|
|
|
230
|
+
config.access_token = @authToken
|
|
231
|
+
end
|
|
232
|
+
|
|
233
|
+
api_instance = PureCloud::WorkforceManagementApi.new
|
|
234
|
+
|
|
235
|
+
mu_id = "mu_id_example" # String | The muId of the management unit.
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
begin
|
|
239
|
+
#Get agents in the management unit
|
|
240
|
+
result = api_instance.get_managementunits_mu_id_users(mu_id)
|
|
241
|
+
p result
|
|
242
|
+
rescue PureCloud::ApiError => e
|
|
243
|
+
puts "Exception when calling WorkforceManagementApi->get_managementunits_mu_id_users: #{e}"
|
|
244
|
+
end
|
|
245
|
+
~~~
|
|
246
|
+
|
|
247
|
+
### Parameters
|
|
248
|
+
|
|
249
|
+
Name | Type | Description | Notes
|
|
250
|
+
------------- | ------------- | ------------- | -------------
|
|
251
|
+
**mu_id** | **String**| The muId of the management unit. |
|
|
252
|
+
{: class="table table-striped"}
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
### Return type
|
|
256
|
+
|
|
257
|
+
[**WfmUserEntityListing**](WfmUserEntityListing.html)
|
|
258
|
+
|
|
259
|
+
### HTTP request headers
|
|
260
|
+
|
|
261
|
+
- **Content-Type**: application/json
|
|
262
|
+
- **Accept**: application/json
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
|
|
139
266
|
<a name="get_managementunits_mu_id_users_user_id_timeoffrequests"></a>
|
|
140
267
|
|
|
141
268
|
## -[**TimeOffRequestList**](TimeOffRequestList.html) get_managementunits_mu_id_users_user_id_timeoffrequests(mu_id, user_id, opts)
|
|
@@ -144,6 +271,9 @@ Get a list of time off requests for any user
|
|
|
144
271
|
|
|
145
272
|
|
|
146
273
|
|
|
274
|
+
Wraps GET /api/v2/workforcemanagement/managementunits/{muId}/users/{userId}/timeoffrequests
|
|
275
|
+
|
|
276
|
+
|
|
147
277
|
### Example
|
|
148
278
|
~~~ruby
|
|
149
279
|
# load the gem
|
|
@@ -207,6 +337,9 @@ Get a time off request by id
|
|
|
207
337
|
|
|
208
338
|
|
|
209
339
|
|
|
340
|
+
Wraps GET /api/v2/workforcemanagement/managementunits/{muId}/users/{userId}/timeoffrequests/{timeOffRequestId}
|
|
341
|
+
|
|
342
|
+
|
|
210
343
|
### Example
|
|
211
344
|
~~~ruby
|
|
212
345
|
# load the gem
|
|
@@ -269,6 +402,9 @@ Get a list of time off requests for the current user
|
|
|
269
402
|
|
|
270
403
|
|
|
271
404
|
|
|
405
|
+
Wraps GET /api/v2/workforcemanagement/timeoffrequests
|
|
406
|
+
|
|
407
|
+
|
|
272
408
|
### Example
|
|
273
409
|
~~~ruby
|
|
274
410
|
# load the gem
|
|
@@ -326,6 +462,9 @@ Get a time off request for the current user by id
|
|
|
326
462
|
|
|
327
463
|
|
|
328
464
|
|
|
465
|
+
Wraps GET /api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}
|
|
466
|
+
|
|
467
|
+
|
|
329
468
|
### Example
|
|
330
469
|
~~~ruby
|
|
331
470
|
# load the gem
|
|
@@ -382,6 +521,9 @@ Mark a time off request for the current user as read or unread
|
|
|
382
521
|
|
|
383
522
|
|
|
384
523
|
|
|
524
|
+
Wraps PATCH /api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}
|
|
525
|
+
|
|
526
|
+
|
|
385
527
|
### Example
|
|
386
528
|
~~~ruby
|
|
387
529
|
# load the gem
|
|
@@ -441,6 +583,9 @@ Download decisions files metadata
|
|
|
441
583
|
|
|
442
584
|
|
|
443
585
|
|
|
586
|
+
Wraps POST /api/v2/workforcemanagement/decisions/downloads/search
|
|
587
|
+
|
|
588
|
+
|
|
444
589
|
### Example
|
|
445
590
|
~~~ruby
|
|
446
591
|
# load the gem
|
|
@@ -497,6 +642,9 @@ Create a forecast
|
|
|
497
642
|
|
|
498
643
|
|
|
499
644
|
|
|
645
|
+
Wraps POST /api/v2/workforcemanagement/longtermforecasts
|
|
646
|
+
|
|
647
|
+
|
|
500
648
|
### Example
|
|
501
649
|
~~~ruby
|
|
502
650
|
# load the gem
|
|
@@ -545,14 +693,80 @@ Name | Type | Description | Notes
|
|
|
545
693
|
|
|
546
694
|
|
|
547
695
|
|
|
696
|
+
<a name="post_managementunits_mu_id_schedules_search"></a>
|
|
697
|
+
|
|
698
|
+
## -[**UserScheduleContainer**](UserScheduleContainer.html) post_managementunits_mu_id_schedules_search(mu_id, opts)
|
|
699
|
+
|
|
700
|
+
Get user schedules within the given time range
|
|
701
|
+
|
|
702
|
+
|
|
703
|
+
|
|
704
|
+
Wraps POST /api/v2/workforcemanagement/managementunits/{muId}/schedules/search
|
|
705
|
+
|
|
706
|
+
|
|
707
|
+
### Example
|
|
708
|
+
~~~ruby
|
|
709
|
+
# load the gem
|
|
710
|
+
require 'purecloud'
|
|
711
|
+
# setup authorization
|
|
712
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
713
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
714
|
+
environment = "mypurecloud.com"
|
|
715
|
+
|
|
716
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
717
|
+
|
|
718
|
+
PureCloud.configure do |config|
|
|
719
|
+
config.access_token = @authToken
|
|
720
|
+
end
|
|
721
|
+
|
|
722
|
+
api_instance = PureCloud::WorkforceManagementApi.new
|
|
723
|
+
|
|
724
|
+
mu_id = "mu_id_example" # String | The muId of the management unit.
|
|
725
|
+
|
|
726
|
+
opts = {
|
|
727
|
+
body: PureCloud::UserListScheduleRequestBody.new # UserListScheduleRequestBody | body
|
|
728
|
+
}
|
|
729
|
+
|
|
730
|
+
begin
|
|
731
|
+
#Get user schedules within the given time range
|
|
732
|
+
result = api_instance.post_managementunits_mu_id_schedules_search(mu_id, opts)
|
|
733
|
+
p result
|
|
734
|
+
rescue PureCloud::ApiError => e
|
|
735
|
+
puts "Exception when calling WorkforceManagementApi->post_managementunits_mu_id_schedules_search: #{e}"
|
|
736
|
+
end
|
|
737
|
+
~~~
|
|
738
|
+
|
|
739
|
+
### Parameters
|
|
740
|
+
|
|
741
|
+
Name | Type | Description | Notes
|
|
742
|
+
------------- | ------------- | ------------- | -------------
|
|
743
|
+
**mu_id** | **String**| The muId of the management unit. |
|
|
744
|
+
**body** | [**UserListScheduleRequestBody**](UserListScheduleRequestBody.html)| body | [optional]
|
|
745
|
+
{: class="table table-striped"}
|
|
746
|
+
|
|
747
|
+
|
|
748
|
+
### Return type
|
|
749
|
+
|
|
750
|
+
[**UserScheduleContainer**](UserScheduleContainer.html)
|
|
751
|
+
|
|
752
|
+
### HTTP request headers
|
|
753
|
+
|
|
754
|
+
- **Content-Type**: application/json
|
|
755
|
+
- **Accept**: application/json
|
|
756
|
+
|
|
757
|
+
|
|
758
|
+
|
|
548
759
|
<a name="post_schedules"></a>
|
|
549
760
|
|
|
550
|
-
## -[**
|
|
761
|
+
## -[**UserScheduleContainer**](UserScheduleContainer.html) post_schedules(opts)
|
|
551
762
|
|
|
552
763
|
Get a schedule for the current user
|
|
553
764
|
|
|
554
765
|
|
|
555
766
|
|
|
767
|
+
Wraps POST /api/v2/workforcemanagement/schedules
|
|
768
|
+
|
|
769
|
+
|
|
556
770
|
### Example
|
|
557
771
|
~~~ruby
|
|
558
772
|
# load the gem
|
|
@@ -593,7 +807,7 @@ Name | Type | Description | Notes
|
|
|
593
807
|
|
|
594
808
|
### Return type
|
|
595
809
|
|
|
596
|
-
[**
|
|
810
|
+
[**UserScheduleContainer**](UserScheduleContainer.html)
|
|
597
811
|
|
|
598
812
|
### HTTP request headers
|
|
599
813
|
|