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
@@ -0,0 +1,15 @@
|
|
1
|
+
---
|
2
|
+
title: RecordingDataV2NotificationLockData
|
3
|
+
---
|
4
|
+
## PureCloud::RecordingDataV2NotificationLockData
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **locked_by** | [**RecordingDataV2NotificationUserData**](RecordingDataV2NotificationUserData.html) | | [optional] |
|
11
|
+
| **date_created** | **DateTime** | | [optional] |
|
12
|
+
| **date_expires** | **DateTime** | | [optional] |
|
13
|
+
{: class="table table-striped"}
|
14
|
+
|
15
|
+
|
@@ -0,0 +1,15 @@
|
|
1
|
+
---
|
2
|
+
title: RecordingDataV2NotificationLockInfo
|
3
|
+
---
|
4
|
+
## PureCloud::RecordingDataV2NotificationLockInfo
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **locked_by** | [**RecordingDataV2NotificationUserData**](RecordingDataV2NotificationUserData.html) | | [optional] |
|
11
|
+
| **date_created** | **DateTime** | | [optional] |
|
12
|
+
| **date_expires** | **DateTime** | | [optional] |
|
13
|
+
{: class="table table-striped"}
|
14
|
+
|
15
|
+
|
@@ -11,11 +11,11 @@ title: ReportMetaDataEntityListing
|
|
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: ReportRunEntryEntityDomainListing
|
|
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: ReportScheduleEntityListing
|
|
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: ResponseEntityList
|
|
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: ResponseEntityListing
|
|
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,19 +6,19 @@ title: ResponseManagementApi
|
|
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
|
-
|
11
|
+
[**delete_libraries_library_id**](ResponseManagementApi.html#delete_libraries_library_id) | Delete an existing response library.
|
12
|
+
[**delete_responses_response_id**](ResponseManagementApi.html#delete_responses_response_id) | Delete an existing response.
|
13
|
+
[**get_libraries**](ResponseManagementApi.html#get_libraries) | Gets a list of existing response libraries.
|
14
|
+
[**get_libraries_library_id**](ResponseManagementApi.html#get_libraries_library_id) | Get details about an existing response library.
|
15
|
+
[**get_responses**](ResponseManagementApi.html#get_responses) | Gets a list of existing responses.
|
16
|
+
[**get_responses_response_id**](ResponseManagementApi.html#get_responses_response_id) | Get details about an existing response.
|
17
|
+
[**post_libraries**](ResponseManagementApi.html#post_libraries) | Create a response library.
|
18
|
+
[**post_responses**](ResponseManagementApi.html#post_responses) | Create a response.
|
19
|
+
[**post_responses_query**](ResponseManagementApi.html#post_responses_query) | Query responses
|
20
|
+
[**put_libraries_library_id**](ResponseManagementApi.html#put_libraries_library_id) | Update an existing response library.
|
21
|
+
[**put_responses_response_id**](ResponseManagementApi.html#put_responses_response_id) | Update an existing response.
|
22
22
|
{: class="table table-striped"}
|
23
23
|
|
24
24
|
<a name="delete_libraries_library_id"></a>
|
@@ -29,6 +29,9 @@ Delete an existing response library.
|
|
29
29
|
|
30
30
|
This will remove any responses associated with the library.
|
31
31
|
|
32
|
+
Wraps DELETE /api/v2/responsemanagement/libraries/{libraryId}
|
33
|
+
|
34
|
+
|
32
35
|
### Example
|
33
36
|
~~~ruby
|
34
37
|
# load the gem
|
@@ -84,6 +87,9 @@ Delete an existing response.
|
|
84
87
|
|
85
88
|
This will remove the response from any libraries associated with it.
|
86
89
|
|
90
|
+
Wraps DELETE /api/v2/responsemanagement/responses/{responseId}
|
91
|
+
|
92
|
+
|
87
93
|
### Example
|
88
94
|
~~~ruby
|
89
95
|
# load the gem
|
@@ -139,6 +145,9 @@ Gets a list of existing response libraries.
|
|
139
145
|
|
140
146
|
|
141
147
|
|
148
|
+
Wraps GET /api/v2/responsemanagement/libraries
|
149
|
+
|
150
|
+
|
142
151
|
### Example
|
143
152
|
~~~ruby
|
144
153
|
# load the gem
|
@@ -198,6 +207,9 @@ Get details about an existing response library.
|
|
198
207
|
|
199
208
|
|
200
209
|
|
210
|
+
Wraps GET /api/v2/responsemanagement/libraries/{libraryId}
|
211
|
+
|
212
|
+
|
201
213
|
### Example
|
202
214
|
~~~ruby
|
203
215
|
# load the gem
|
@@ -254,6 +266,9 @@ Gets a list of existing responses.
|
|
254
266
|
|
255
267
|
|
256
268
|
|
269
|
+
Wraps GET /api/v2/responsemanagement/responses
|
270
|
+
|
271
|
+
|
257
272
|
### Example
|
258
273
|
~~~ruby
|
259
274
|
# load the gem
|
@@ -316,6 +331,9 @@ Get details about an existing response.
|
|
316
331
|
|
317
332
|
|
318
333
|
|
334
|
+
Wraps GET /api/v2/responsemanagement/responses/{responseId}
|
335
|
+
|
336
|
+
|
319
337
|
### Example
|
320
338
|
~~~ruby
|
321
339
|
# load the gem
|
@@ -372,6 +390,9 @@ Create a response library.
|
|
372
390
|
|
373
391
|
|
374
392
|
|
393
|
+
Wraps POST /api/v2/responsemanagement/libraries
|
394
|
+
|
395
|
+
|
375
396
|
### Example
|
376
397
|
~~~ruby
|
377
398
|
# load the gem
|
@@ -428,6 +449,9 @@ Create a response.
|
|
428
449
|
|
429
450
|
|
430
451
|
|
452
|
+
Wraps POST /api/v2/responsemanagement/responses
|
453
|
+
|
454
|
+
|
431
455
|
### Example
|
432
456
|
~~~ruby
|
433
457
|
# load the gem
|
@@ -484,6 +508,9 @@ Query responses
|
|
484
508
|
|
485
509
|
|
486
510
|
|
511
|
+
Wraps POST /api/v2/responsemanagement/responses/query
|
512
|
+
|
513
|
+
|
487
514
|
### Example
|
488
515
|
~~~ruby
|
489
516
|
# load the gem
|
@@ -540,6 +567,9 @@ Update an existing response library.
|
|
540
567
|
|
541
568
|
Fields that can be updated: name. The most recent version is required for updates.
|
542
569
|
|
570
|
+
Wraps PUT /api/v2/responsemanagement/libraries/{libraryId}
|
571
|
+
|
572
|
+
|
543
573
|
### Example
|
544
574
|
~~~ruby
|
545
575
|
# load the gem
|
@@ -599,6 +629,9 @@ Update an existing response.
|
|
599
629
|
|
600
630
|
Fields that can be updated: name, libraries, and texts. The most recent version is required for updates.
|
601
631
|
|
632
|
+
Wraps PUT /api/v2/responsemanagement/responses/{responseId}
|
633
|
+
|
634
|
+
|
602
635
|
### Example
|
603
636
|
~~~ruby
|
604
637
|
# load the gem
|
@@ -11,11 +11,11 @@ title: ResponseSetEntityListing
|
|
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
|
|
@@ -12,8 +12,8 @@ title: ResponseSetNotification
|
|
12
12
|
| **date_created** | **DateTime** | | [optional] |
|
13
13
|
| **date_modified** | **DateTime** | | [optional] |
|
14
14
|
| **version** | **Integer** | | [optional] |
|
15
|
-
| **additional_properties** | **Object** | | [optional] |
|
16
15
|
| **responses** | [**Hash<String, ResponseSetNotificationResponses>**](ResponseSetNotificationResponses.html) | | [optional] |
|
16
|
+
| **additional_properties** | **Object** | | [optional] |
|
17
17
|
{: class="table table-striped"}
|
18
18
|
|
19
19
|
|
data/doc_out/RoutingApi.html.md
CHANGED
@@ -6,56 +6,56 @@ title: RoutingApi
|
|
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
|
-
|
53
|
-
|
54
|
-
|
55
|
-
|
56
|
-
|
57
|
-
|
58
|
-
|
11
|
+
[**delete_email_domains_domain_id**](RoutingApi.html#delete_email_domains_domain_id) | Delete a domain
|
12
|
+
[**delete_email_domains_domainname_routes_route_id**](RoutingApi.html#delete_email_domains_domainname_routes_route_id) | Delete a route
|
13
|
+
[**delete_queues_queue_id**](RoutingApi.html#delete_queues_queue_id) | Delete a queue
|
14
|
+
[**delete_queues_queue_id_users_member_id**](RoutingApi.html#delete_queues_queue_id_users_member_id) | Delete queue member
|
15
|
+
[**delete_queues_queue_id_wrapupcodes_code_id**](RoutingApi.html#delete_queues_queue_id_wrapupcodes_code_id) | Delete a wrap-up code from a queue
|
16
|
+
[**delete_skills_skill_id**](RoutingApi.html#delete_skills_skill_id) | Delete Routing Skill
|
17
|
+
[**delete_user_id_routingskills_skill_id**](RoutingApi.html#delete_user_id_routingskills_skill_id) | Remove routing skill from user
|
18
|
+
[**delete_utilization**](RoutingApi.html#delete_utilization) | Delete utilization settings and revert to system defaults.
|
19
|
+
[**delete_wrapupcodes_code_id**](RoutingApi.html#delete_wrapupcodes_code_id) | Delete wrap-up code
|
20
|
+
[**get_email_domains**](RoutingApi.html#get_email_domains) | Get domains
|
21
|
+
[**get_email_domains_domain_id**](RoutingApi.html#get_email_domains_domain_id) | Get domain
|
22
|
+
[**get_email_domains_domainname_routes**](RoutingApi.html#get_email_domains_domainname_routes) | Get routes
|
23
|
+
[**get_email_domains_domainname_routes_route_id**](RoutingApi.html#get_email_domains_domainname_routes_route_id) | Get a route
|
24
|
+
[**get_email_setup**](RoutingApi.html#get_email_setup) | Get email setup
|
25
|
+
[**get_languages**](RoutingApi.html#get_languages) | Get the list of supported languages.
|
26
|
+
[**get_queues**](RoutingApi.html#get_queues) | Get list of queues.
|
27
|
+
[**get_queues_queue_id**](RoutingApi.html#get_queues_queue_id) | Get details about this queue.
|
28
|
+
[**get_queues_queue_id_conversations**](RoutingApi.html#get_queues_queue_id_conversations) | Get recent conversations that are still active
|
29
|
+
[**get_queues_queue_id_conversations_callbacks**](RoutingApi.html#get_queues_queue_id_conversations_callbacks) | Get recent callback conversations that are still active
|
30
|
+
[**get_queues_queue_id_conversations_calls**](RoutingApi.html#get_queues_queue_id_conversations_calls) | Get recent call conversations that are still active
|
31
|
+
[**get_queues_queue_id_conversations_chats**](RoutingApi.html#get_queues_queue_id_conversations_chats) | Get recent chat conversations that are still active
|
32
|
+
[**get_queues_queue_id_conversations_emails**](RoutingApi.html#get_queues_queue_id_conversations_emails) | Get recent email conversations that are still active
|
33
|
+
[**get_queues_queue_id_estimatedwaittime**](RoutingApi.html#get_queues_queue_id_estimatedwaittime) | Get Estimated Wait Time
|
34
|
+
[**get_queues_queue_id_users**](RoutingApi.html#get_queues_queue_id_users) | Get the members of this queue
|
35
|
+
[**get_queues_queue_id_wrapupcodes**](RoutingApi.html#get_queues_queue_id_wrapupcodes) | Get the wrap-up codes for a queue
|
36
|
+
[**get_skills**](RoutingApi.html#get_skills) | Get the list of routing skills.
|
37
|
+
[**get_skills_skill_id**](RoutingApi.html#get_skills_skill_id) | Get Routing Skill
|
38
|
+
[**get_user_id_routingskills**](RoutingApi.html#get_user_id_routingskills) | List routing skills for user
|
39
|
+
[**get_utilization**](RoutingApi.html#get_utilization) | Get the utilization settings.
|
40
|
+
[**get_wrapupcodes**](RoutingApi.html#get_wrapupcodes) | Get list of wrapup codes.
|
41
|
+
[**get_wrapupcodes_code_id**](RoutingApi.html#get_wrapupcodes_code_id) | Get details about this wrap-up code.
|
42
|
+
[**patch_queues_queue_id_users**](RoutingApi.html#patch_queues_queue_id_users) | Join or unjoin a set of users for a queue
|
43
|
+
[**patch_queues_queue_id_users_member_id**](RoutingApi.html#patch_queues_queue_id_users_member_id) | Update the ring number of joined status for a User in a Queue
|
44
|
+
[**post_email_domains**](RoutingApi.html#post_email_domains) | Create a domain
|
45
|
+
[**post_email_domains_domainname_routes**](RoutingApi.html#post_email_domains_domainname_routes) | Create a route
|
46
|
+
[**post_languages**](RoutingApi.html#post_languages) | Create Language
|
47
|
+
[**post_queues**](RoutingApi.html#post_queues) | Create queue
|
48
|
+
[**post_queues_observations_query**](RoutingApi.html#post_queues_observations_query) | Query for queue observations
|
49
|
+
[**post_queues_queue_id_users**](RoutingApi.html#post_queues_queue_id_users) | Bulk add or delete up to 100 queue members
|
50
|
+
[**post_queues_queue_id_wrapupcodes**](RoutingApi.html#post_queues_queue_id_wrapupcodes) | Add up to 100 wrap-up codes to a queue
|
51
|
+
[**post_skills**](RoutingApi.html#post_skills) | Create Skill
|
52
|
+
[**post_user_id_routingskills**](RoutingApi.html#post_user_id_routingskills) | Add routing skill to user
|
53
|
+
[**post_wrapupcodes**](RoutingApi.html#post_wrapupcodes) | Create a wrap-up code
|
54
|
+
[**put_email_domains_domainname_routes_route_id**](RoutingApi.html#put_email_domains_domainname_routes_route_id) | Update a route
|
55
|
+
[**put_queues_queue_id**](RoutingApi.html#put_queues_queue_id) | Update a queue
|
56
|
+
[**put_user_id_routingskills_skill_id**](RoutingApi.html#put_user_id_routingskills_skill_id) | Update routing skill proficiency or state.
|
57
|
+
[**put_utilization**](RoutingApi.html#put_utilization) | Update the utilization settings.
|
58
|
+
[**put_wrapupcodes_code_id**](RoutingApi.html#put_wrapupcodes_code_id) | Update wrap-up code
|
59
59
|
{: class="table table-striped"}
|
60
60
|
|
61
61
|
<a name="delete_email_domains_domain_id"></a>
|
@@ -66,6 +66,9 @@ Delete a domain
|
|
66
66
|
|
67
67
|
|
68
68
|
|
69
|
+
Wraps DELETE /api/v2/routing/email/domains/{domainId}
|
70
|
+
|
71
|
+
|
69
72
|
### Example
|
70
73
|
~~~ruby
|
71
74
|
# load the gem
|
@@ -122,6 +125,9 @@ Delete a route
|
|
122
125
|
|
123
126
|
|
124
127
|
|
128
|
+
Wraps DELETE /api/v2/routing/email/domains/{domainName}/routes/{routeId}
|
129
|
+
|
130
|
+
|
125
131
|
### Example
|
126
132
|
~~~ruby
|
127
133
|
# load the gem
|
@@ -181,6 +187,9 @@ Delete a queue
|
|
181
187
|
|
182
188
|
|
183
189
|
|
190
|
+
Wraps DELETE /api/v2/routing/queues/{queueId}
|
191
|
+
|
192
|
+
|
184
193
|
### Example
|
185
194
|
~~~ruby
|
186
195
|
# load the gem
|
@@ -241,6 +250,9 @@ Delete queue member
|
|
241
250
|
|
242
251
|
|
243
252
|
|
253
|
+
Wraps DELETE /api/v2/routing/queues/{queueId}/users/{memberId}
|
254
|
+
|
255
|
+
|
244
256
|
### Example
|
245
257
|
~~~ruby
|
246
258
|
# load the gem
|
@@ -300,6 +312,9 @@ Delete a wrap-up code from a queue
|
|
300
312
|
|
301
313
|
|
302
314
|
|
315
|
+
Wraps DELETE /api/v2/routing/queues/{queueId}/wrapupcodes/{codeId}
|
316
|
+
|
317
|
+
|
303
318
|
### Example
|
304
319
|
~~~ruby
|
305
320
|
# load the gem
|
@@ -359,6 +374,9 @@ Delete Routing Skill
|
|
359
374
|
|
360
375
|
|
361
376
|
|
377
|
+
Wraps DELETE /api/v2/routing/skills/{skillId}
|
378
|
+
|
379
|
+
|
362
380
|
### Example
|
363
381
|
~~~ruby
|
364
382
|
# load the gem
|
@@ -415,6 +433,9 @@ Remove routing skill from user
|
|
415
433
|
|
416
434
|
|
417
435
|
|
436
|
+
Wraps DELETE /api/v2/users/{userId}/routingskills/{skillId}
|
437
|
+
|
438
|
+
|
418
439
|
### Example
|
419
440
|
~~~ruby
|
420
441
|
# load the gem
|
@@ -474,6 +495,9 @@ Delete utilization settings and revert to system defaults.
|
|
474
495
|
|
475
496
|
|
476
497
|
|
498
|
+
Wraps DELETE /api/v2/routing/utilization
|
499
|
+
|
500
|
+
|
477
501
|
### Example
|
478
502
|
~~~ruby
|
479
503
|
# load the gem
|
@@ -524,6 +548,9 @@ Delete wrap-up code
|
|
524
548
|
|
525
549
|
|
526
550
|
|
551
|
+
Wraps DELETE /api/v2/routing/wrapupcodes/{codeId}
|
552
|
+
|
553
|
+
|
527
554
|
### Example
|
528
555
|
~~~ruby
|
529
556
|
# load the gem
|
@@ -580,6 +607,9 @@ Get domains
|
|
580
607
|
|
581
608
|
|
582
609
|
|
610
|
+
Wraps GET /api/v2/routing/email/domains
|
611
|
+
|
612
|
+
|
583
613
|
### Example
|
584
614
|
~~~ruby
|
585
615
|
# load the gem
|
@@ -630,6 +660,9 @@ Get domain
|
|
630
660
|
|
631
661
|
|
632
662
|
|
663
|
+
Wraps GET /api/v2/routing/email/domains/{domainId}
|
664
|
+
|
665
|
+
|
633
666
|
### Example
|
634
667
|
~~~ruby
|
635
668
|
# load the gem
|
@@ -686,6 +719,9 @@ Get routes
|
|
686
719
|
|
687
720
|
|
688
721
|
|
722
|
+
Wraps GET /api/v2/routing/email/domains/{domainName}/routes
|
723
|
+
|
724
|
+
|
689
725
|
### Example
|
690
726
|
~~~ruby
|
691
727
|
# load the gem
|
@@ -750,6 +786,9 @@ Get a route
|
|
750
786
|
|
751
787
|
|
752
788
|
|
789
|
+
Wraps GET /api/v2/routing/email/domains/{domainName}/routes/{routeId}
|
790
|
+
|
791
|
+
|
753
792
|
### Example
|
754
793
|
~~~ruby
|
755
794
|
# load the gem
|
@@ -809,6 +848,9 @@ Get email setup
|
|
809
848
|
|
810
849
|
|
811
850
|
|
851
|
+
Wraps GET /api/v2/routing/email/setup
|
852
|
+
|
853
|
+
|
812
854
|
### Example
|
813
855
|
~~~ruby
|
814
856
|
# load the gem
|
@@ -859,6 +901,9 @@ Get the list of supported languages.
|
|
859
901
|
|
860
902
|
|
861
903
|
|
904
|
+
Wraps GET /api/v2/routing/languages
|
905
|
+
|
906
|
+
|
862
907
|
### Example
|
863
908
|
~~~ruby
|
864
909
|
# load the gem
|
@@ -922,6 +967,9 @@ Get list of queues.
|
|
922
967
|
|
923
968
|
|
924
969
|
|
970
|
+
Wraps GET /api/v2/routing/queues
|
971
|
+
|
972
|
+
|
925
973
|
### Example
|
926
974
|
~~~ruby
|
927
975
|
# load the gem
|
@@ -987,6 +1035,9 @@ Get details about this queue.
|
|
987
1035
|
|
988
1036
|
|
989
1037
|
|
1038
|
+
Wraps GET /api/v2/routing/queues/{queueId}
|
1039
|
+
|
1040
|
+
|
990
1041
|
### Example
|
991
1042
|
~~~ruby
|
992
1043
|
# load the gem
|
@@ -1043,6 +1094,9 @@ Get recent conversations that are still active
|
|
1043
1094
|
|
1044
1095
|
|
1045
1096
|
|
1097
|
+
Wraps GET /api/v2/routing/queues/{queueId}/conversations
|
1098
|
+
|
1099
|
+
|
1046
1100
|
### Example
|
1047
1101
|
~~~ruby
|
1048
1102
|
# load the gem
|
@@ -1105,6 +1159,9 @@ Get recent callback conversations that are still active
|
|
1105
1159
|
|
1106
1160
|
|
1107
1161
|
|
1162
|
+
Wraps GET /api/v2/routing/queues/{queueId}/conversations/callbacks
|
1163
|
+
|
1164
|
+
|
1108
1165
|
### Example
|
1109
1166
|
~~~ruby
|
1110
1167
|
# load the gem
|
@@ -1167,6 +1224,9 @@ Get recent call conversations that are still active
|
|
1167
1224
|
|
1168
1225
|
|
1169
1226
|
|
1227
|
+
Wraps GET /api/v2/routing/queues/{queueId}/conversations/calls
|
1228
|
+
|
1229
|
+
|
1170
1230
|
### Example
|
1171
1231
|
~~~ruby
|
1172
1232
|
# load the gem
|
@@ -1229,6 +1289,9 @@ Get recent chat conversations that are still active
|
|
1229
1289
|
|
1230
1290
|
|
1231
1291
|
|
1292
|
+
Wraps GET /api/v2/routing/queues/{queueId}/conversations/chats
|
1293
|
+
|
1294
|
+
|
1232
1295
|
### Example
|
1233
1296
|
~~~ruby
|
1234
1297
|
# load the gem
|
@@ -1291,6 +1354,9 @@ Get recent email conversations that are still active
|
|
1291
1354
|
|
1292
1355
|
|
1293
1356
|
|
1357
|
+
Wraps GET /api/v2/routing/queues/{queueId}/conversations/emails
|
1358
|
+
|
1359
|
+
|
1294
1360
|
### Example
|
1295
1361
|
~~~ruby
|
1296
1362
|
# load the gem
|
@@ -1353,6 +1419,9 @@ Get Estimated Wait Time
|
|
1353
1419
|
|
1354
1420
|
|
1355
1421
|
|
1422
|
+
Wraps GET /api/v2/routing/queues/{queueId}/estimatedwaittime
|
1423
|
+
|
1424
|
+
|
1356
1425
|
### Example
|
1357
1426
|
~~~ruby
|
1358
1427
|
# load the gem
|
@@ -1413,6 +1482,9 @@ Get the members of this queue
|
|
1413
1482
|
|
1414
1483
|
|
1415
1484
|
|
1485
|
+
Wraps GET /api/v2/routing/queues/{queueId}/users
|
1486
|
+
|
1487
|
+
|
1416
1488
|
### Example
|
1417
1489
|
~~~ruby
|
1418
1490
|
# load the gem
|
@@ -1493,6 +1565,9 @@ Get the wrap-up codes for a queue
|
|
1493
1565
|
|
1494
1566
|
|
1495
1567
|
|
1568
|
+
Wraps GET /api/v2/routing/queues/{queueId}/wrapupcodes
|
1569
|
+
|
1570
|
+
|
1496
1571
|
### Example
|
1497
1572
|
~~~ruby
|
1498
1573
|
# load the gem
|
@@ -1549,6 +1624,9 @@ Get the list of routing skills.
|
|
1549
1624
|
|
1550
1625
|
|
1551
1626
|
|
1627
|
+
Wraps GET /api/v2/routing/skills
|
1628
|
+
|
1629
|
+
|
1552
1630
|
### Example
|
1553
1631
|
~~~ruby
|
1554
1632
|
# load the gem
|
@@ -1610,6 +1688,9 @@ Get Routing Skill
|
|
1610
1688
|
|
1611
1689
|
|
1612
1690
|
|
1691
|
+
Wraps GET /api/v2/routing/skills/{skillId}
|
1692
|
+
|
1693
|
+
|
1613
1694
|
### Example
|
1614
1695
|
~~~ruby
|
1615
1696
|
# load the gem
|
@@ -1666,6 +1747,9 @@ List routing skills for user
|
|
1666
1747
|
|
1667
1748
|
|
1668
1749
|
|
1750
|
+
Wraps GET /api/v2/users/{userId}/routingskills
|
1751
|
+
|
1752
|
+
|
1669
1753
|
### Example
|
1670
1754
|
~~~ruby
|
1671
1755
|
# load the gem
|
@@ -1730,6 +1814,9 @@ Get the utilization settings.
|
|
1730
1814
|
|
1731
1815
|
|
1732
1816
|
|
1817
|
+
Wraps GET /api/v2/routing/utilization
|
1818
|
+
|
1819
|
+
|
1733
1820
|
### Example
|
1734
1821
|
~~~ruby
|
1735
1822
|
# load the gem
|
@@ -1780,6 +1867,9 @@ Get list of wrapup codes.
|
|
1780
1867
|
|
1781
1868
|
|
1782
1869
|
|
1870
|
+
Wraps GET /api/v2/routing/wrapupcodes
|
1871
|
+
|
1872
|
+
|
1783
1873
|
### Example
|
1784
1874
|
~~~ruby
|
1785
1875
|
# load the gem
|
@@ -1841,6 +1931,9 @@ Get details about this wrap-up code.
|
|
1841
1931
|
|
1842
1932
|
|
1843
1933
|
|
1934
|
+
Wraps GET /api/v2/routing/wrapupcodes/{codeId}
|
1935
|
+
|
1936
|
+
|
1844
1937
|
### Example
|
1845
1938
|
~~~ruby
|
1846
1939
|
# load the gem
|
@@ -1897,6 +1990,9 @@ Join or unjoin a set of users for a queue
|
|
1897
1990
|
|
1898
1991
|
|
1899
1992
|
|
1993
|
+
Wraps PATCH /api/v2/routing/queues/{queueId}/users
|
1994
|
+
|
1995
|
+
|
1900
1996
|
### Example
|
1901
1997
|
~~~ruby
|
1902
1998
|
# load the gem
|
@@ -1956,6 +2052,9 @@ Update the ring number of joined status for a User in a Queue
|
|
1956
2052
|
|
1957
2053
|
|
1958
2054
|
|
2055
|
+
Wraps PATCH /api/v2/routing/queues/{queueId}/users/{memberId}
|
2056
|
+
|
2057
|
+
|
1959
2058
|
### Example
|
1960
2059
|
~~~ruby
|
1961
2060
|
# load the gem
|
@@ -2018,6 +2117,9 @@ Create a domain
|
|
2018
2117
|
|
2019
2118
|
|
2020
2119
|
|
2120
|
+
Wraps POST /api/v2/routing/email/domains
|
2121
|
+
|
2122
|
+
|
2021
2123
|
### Example
|
2022
2124
|
~~~ruby
|
2023
2125
|
# load the gem
|
@@ -2074,6 +2176,9 @@ Create a route
|
|
2074
2176
|
|
2075
2177
|
|
2076
2178
|
|
2179
|
+
Wraps POST /api/v2/routing/email/domains/{domainName}/routes
|
2180
|
+
|
2181
|
+
|
2077
2182
|
### Example
|
2078
2183
|
~~~ruby
|
2079
2184
|
# load the gem
|
@@ -2133,6 +2238,9 @@ Create Language
|
|
2133
2238
|
|
2134
2239
|
|
2135
2240
|
|
2241
|
+
Wraps POST /api/v2/routing/languages
|
2242
|
+
|
2243
|
+
|
2136
2244
|
### Example
|
2137
2245
|
~~~ruby
|
2138
2246
|
# load the gem
|
@@ -2189,6 +2297,9 @@ Create queue
|
|
2189
2297
|
|
2190
2298
|
|
2191
2299
|
|
2300
|
+
Wraps POST /api/v2/routing/queues
|
2301
|
+
|
2302
|
+
|
2192
2303
|
### Example
|
2193
2304
|
~~~ruby
|
2194
2305
|
# load the gem
|
@@ -2245,6 +2356,9 @@ Query for queue observations
|
|
2245
2356
|
|
2246
2357
|
|
2247
2358
|
|
2359
|
+
Wraps POST /api/v2/analytics/queues/observations/query
|
2360
|
+
|
2361
|
+
|
2248
2362
|
### Example
|
2249
2363
|
~~~ruby
|
2250
2364
|
# load the gem
|
@@ -2301,6 +2415,9 @@ Bulk add or delete up to 100 queue members
|
|
2301
2415
|
|
2302
2416
|
|
2303
2417
|
|
2418
|
+
Wraps POST /api/v2/routing/queues/{queueId}/users
|
2419
|
+
|
2420
|
+
|
2304
2421
|
### Example
|
2305
2422
|
~~~ruby
|
2306
2423
|
# load the gem
|
@@ -2364,6 +2481,9 @@ Add up to 100 wrap-up codes to a queue
|
|
2364
2481
|
|
2365
2482
|
|
2366
2483
|
|
2484
|
+
Wraps POST /api/v2/routing/queues/{queueId}/wrapupcodes
|
2485
|
+
|
2486
|
+
|
2367
2487
|
### Example
|
2368
2488
|
~~~ruby
|
2369
2489
|
# load the gem
|
@@ -2423,6 +2543,9 @@ Create Skill
|
|
2423
2543
|
|
2424
2544
|
|
2425
2545
|
|
2546
|
+
Wraps POST /api/v2/routing/skills
|
2547
|
+
|
2548
|
+
|
2426
2549
|
### Example
|
2427
2550
|
~~~ruby
|
2428
2551
|
# load the gem
|
@@ -2479,6 +2602,9 @@ Add routing skill to user
|
|
2479
2602
|
|
2480
2603
|
|
2481
2604
|
|
2605
|
+
Wraps POST /api/v2/users/{userId}/routingskills
|
2606
|
+
|
2607
|
+
|
2482
2608
|
### Example
|
2483
2609
|
~~~ruby
|
2484
2610
|
# load the gem
|
@@ -2538,6 +2664,9 @@ Create a wrap-up code
|
|
2538
2664
|
|
2539
2665
|
|
2540
2666
|
|
2667
|
+
Wraps POST /api/v2/routing/wrapupcodes
|
2668
|
+
|
2669
|
+
|
2541
2670
|
### Example
|
2542
2671
|
~~~ruby
|
2543
2672
|
# load the gem
|
@@ -2594,6 +2723,9 @@ Update a route
|
|
2594
2723
|
|
2595
2724
|
|
2596
2725
|
|
2726
|
+
Wraps PUT /api/v2/routing/email/domains/{domainName}/routes/{routeId}
|
2727
|
+
|
2728
|
+
|
2597
2729
|
### Example
|
2598
2730
|
~~~ruby
|
2599
2731
|
# load the gem
|
@@ -2656,6 +2788,9 @@ Update a queue
|
|
2656
2788
|
|
2657
2789
|
|
2658
2790
|
|
2791
|
+
Wraps PUT /api/v2/routing/queues/{queueId}
|
2792
|
+
|
2793
|
+
|
2659
2794
|
### Example
|
2660
2795
|
~~~ruby
|
2661
2796
|
# load the gem
|
@@ -2715,6 +2850,9 @@ Update routing skill proficiency or state.
|
|
2715
2850
|
|
2716
2851
|
|
2717
2852
|
|
2853
|
+
Wraps PUT /api/v2/users/{userId}/routingskills/{skillId}
|
2854
|
+
|
2855
|
+
|
2718
2856
|
### Example
|
2719
2857
|
~~~ruby
|
2720
2858
|
# load the gem
|
@@ -2777,6 +2915,9 @@ Update the utilization settings.
|
|
2777
2915
|
|
2778
2916
|
|
2779
2917
|
|
2918
|
+
Wraps PUT /api/v2/routing/utilization
|
2919
|
+
|
2920
|
+
|
2780
2921
|
### Example
|
2781
2922
|
~~~ruby
|
2782
2923
|
# load the gem
|
@@ -2833,6 +2974,9 @@ Update wrap-up code
|
|
2833
2974
|
|
2834
2975
|
|
2835
2976
|
|
2977
|
+
Wraps PUT /api/v2/routing/wrapupcodes/{codeId}
|
2978
|
+
|
2979
|
+
|
2836
2980
|
### Example
|
2837
2981
|
~~~ruby
|
2838
2982
|
# load the gem
|