purecloud 0.67.1 → 0.68.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +3 -3
- data/bin/notificationMappings.json +4 -4
- data/config-ruby.json +1 -1
- data/doc_out/ActivityCode.html.md +20 -0
- data/doc_out/ActivityCodeContainer.html.md +13 -0
- data/doc_out/AgentActivityEntityListing.html.md +2 -2
- data/doc_out/AlertingApi.html.md +137 -35
- data/doc_out/AnalyticsApi.html.md +89 -23
- data/doc_out/AttemptLimitsEntityListing.html.md +2 -2
- data/doc_out/AttemptLimitsNotification.html.md +2 -1
- data/doc_out/AttributeEntityListing.html.md +2 -2
- data/doc_out/AttributesApi.html.md +25 -7
- data/doc_out/AuthorizationApi.html.md +69 -18
- data/doc_out/CalibrationEntityListing.html.md +2 -2
- data/doc_out/CallConversationEntityListing.html.md +2 -2
- data/doc_out/CallConversationNotificationCallMediaParticipant.html.md +1 -1
- data/doc_out/CallConversationNotificationParticipants.html.md +1 -1
- data/doc_out/CallableTimeSetEntityListing.html.md +2 -2
- data/doc_out/CallableTimeSetNotification.html.md +1 -1
- data/doc_out/CallbackConversationEntityListing.html.md +2 -2
- data/doc_out/CallbackConversationNotificationCallbackMediaParticipant.html.md +1 -1
- data/doc_out/CallbackConversationNotificationParticipants.html.md +1 -1
- data/doc_out/CampaignEntityListing.html.md +2 -2
- data/doc_out/CampaignNotification.html.md +2 -2
- data/doc_out/{CampaignNotificationError.html.md → CampaignNotificationRestErrorDetail.html.md} +2 -2
- data/doc_out/CampaignProgressNotification.html.md +1 -1
- data/doc_out/CampaignRuleEntityListing.html.md +2 -2
- data/doc_out/CampaignRuleNotification.html.md +1 -1
- data/doc_out/CampaignRuleNotificationCampaignRuleActionEntities.html.md +2 -2
- data/doc_out/CampaignRuleNotificationCampaignRuleEntities.html.md +2 -3
- data/doc_out/CampaignRuleNotificationUriReference.html.md +14 -0
- data/doc_out/CampaignScheduleNotification.html.md +2 -2
- data/doc_out/CampaignSequenceEntityListing.html.md +2 -2
- data/doc_out/CampaignSequenceNotification.html.md +2 -2
- data/doc_out/CertificateAuthorityEntityListing.html.md +2 -2
- data/doc_out/ChannelEntityListing.html.md +2 -2
- data/doc_out/ChatConversationEntityListing.html.md +2 -2
- data/doc_out/ChatConversationNotificationChatMediaParticipant.html.md +1 -1
- data/doc_out/ChatConversationNotificationParticipants.html.md +1 -1
- data/doc_out/CobrowseConversationEntityListing.html.md +2 -2
- data/doc_out/CobrowseConversationNotificationCobrowseMediaParticipant.html.md +1 -1
- data/doc_out/CobrowseConversationNotificationParticipants.html.md +1 -1
- data/doc_out/CommandStatusEntityListing.html.md +2 -2
- data/doc_out/ContactListEntityListing.html.md +2 -2
- data/doc_out/ContactListNotification.html.md +2 -2
- data/doc_out/{ContactListNotificationPhoneColumn_.html.md → ContactListNotificationContactPhoneNumberColumn.html.md} +2 -2
- data/doc_out/ContentManagementApi.html.md +153 -39
- data/doc_out/ConversationEntityListing.html.md +2 -2
- data/doc_out/ConversationsApi.html.md +421 -76
- data/doc_out/CreateEmailRequest.html.md +23 -0
- data/doc_out/CreateWebChatRequest.html.md +19 -0
- data/doc_out/DIDEntityListing.html.md +2 -2
- data/doc_out/DIDPoolEntityListing.html.md +2 -2
- data/doc_out/DecisionsFileMetadataEntityListing.html.md +2 -2
- data/doc_out/DncListEntityListing.html.md +2 -2
- data/doc_out/DncListNotification.html.md +1 -1
- data/doc_out/DocumentAuditEntityListing.html.md +2 -2
- data/doc_out/DocumentDataV2Notification.html.md +26 -0
- data/doc_out/{RecordingDataNotificationUserData.html.md → DocumentDataV2NotificationCreatedBy.html.md} +2 -2
- data/doc_out/DocumentDataV2NotificationLockData.html.md +15 -0
- data/doc_out/DocumentDataV2NotificationLockInfo.html.md +15 -0
- data/doc_out/{DocumentDataNotificationUserData.html.md → DocumentDataV2NotificationUserData.html.md} +2 -2
- data/doc_out/{DocumentDataNotificationWorkspace.html.md → DocumentDataV2NotificationWorkspace.html.md} +2 -2
- data/doc_out/{DocumentDataNotificationWorkspaceData.html.md → DocumentDataV2NotificationWorkspaceData.html.md} +2 -2
- data/doc_out/DocumentEntityListing.html.md +2 -2
- data/doc_out/DomainEdgeSoftwareVersionDtoEntityListing.html.md +2 -2
- data/doc_out/DomainEntityListing.html.md +2 -2
- data/doc_out/DomainEntityListingEvaluationForm.html.md +2 -2
- data/doc_out/DomainEntityListingQueryResult.html.md +2 -2
- data/doc_out/DomainOrganizationRole.html.md +1 -1
- data/doc_out/DomainOrganizationRoleCreate.html.md +1 -1
- data/doc_out/DomainOrganizationRoleUpdate.html.md +1 -1
- data/doc_out/EdgeEntityListing.html.md +2 -2
- data/doc_out/EdgeGroupEntityListing.html.md +2 -2
- data/doc_out/EdgeLineEntityListing.html.md +2 -2
- data/doc_out/EdgeRebootParameters.html.md +13 -0
- data/doc_out/EmailConversationEntityListing.html.md +2 -2
- data/doc_out/EmailConversationNotificationEmailMediaParticipant.html.md +1 -1
- data/doc_out/EmailConversationNotificationParticipants.html.md +1 -1
- data/doc_out/EmailMessageListing.html.md +2 -2
- data/doc_out/EncryptionKeyEntityListing.html.md +2 -2
- data/doc_out/EndpointEntityListing.html.md +2 -2
- data/doc_out/Entry.html.md +2 -2
- data/doc_out/EntryFeatureBoolean.html.md +14 -0
- data/doc_out/EvaluationEntityListing.html.md +2 -2
- data/doc_out/EvaluationFormEntityListing.html.md +2 -2
- data/doc_out/EvaluatorActivityEntityListing.html.md +2 -2
- data/doc_out/ExtensionEntityListing.html.md +2 -2
- data/doc_out/ExtensionPoolEntityListing.html.md +2 -2
- data/doc_out/FaxApi.html.md +25 -7
- data/doc_out/FaxDataV2Notification.html.md +29 -0
- data/doc_out/FaxDataV2NotificationLockData.html.md +15 -0
- data/doc_out/FaxDataV2NotificationLockInfo.html.md +15 -0
- data/doc_out/{FaxDataNotificationUserData.html.md → FaxDataV2NotificationUserData.html.md} +2 -2
- data/doc_out/{FaxDataNotificationWorkspaceData.html.md → FaxDataV2NotificationWorkspaceData.html.md} +2 -2
- data/doc_out/FaxDocumentEntityListing.html.md +2 -2
- data/doc_out/GeolocationApi.html.md +17 -5
- data/doc_out/GreetingListing.html.md +2 -2
- data/doc_out/GreetingsApi.html.md +65 -17
- data/doc_out/GroupEntityListing.html.md +2 -2
- data/doc_out/GroupsApi.html.md +45 -12
- data/doc_out/HeartBeatAlertContainer.html.md +2 -2
- data/doc_out/HeartBeatRuleContainer.html.md +2 -2
- data/doc_out/IdentityProviderApi.html.md +89 -23
- data/doc_out/InboundDomainEntityListing.html.md +2 -2
- data/doc_out/InboundRouteEntityListing.html.md +2 -2
- data/doc_out/InteractionStatsAlertContainer.html.md +2 -2
- data/doc_out/InteractionStatsRuleContainer.html.md +2 -2
- data/doc_out/JsonNode.html.md +2 -2
- data/doc_out/KeywordSetEntityListing.html.md +2 -2
- data/doc_out/LanguageEntityListing.html.md +2 -2
- data/doc_out/LanguagesApi.html.md +41 -11
- data/doc_out/LibraryEntityListing.html.md +2 -2
- data/doc_out/LineBaseEntityListing.html.md +2 -2
- data/doc_out/LineEntityListing.html.md +2 -2
- data/doc_out/LocalEncryptionConfigurationListing.html.md +2 -2
- data/doc_out/LocationsApi.html.md +17 -5
- data/doc_out/LogicalInterfaceEntityListing.html.md +2 -2
- data/doc_out/NotificationsApi.html.md +29 -8
- data/doc_out/OAuthApi.html.md +25 -7
- data/doc_out/OAuthClientEntityListing.html.md +2 -2
- data/doc_out/OAuthProviderEntityListing.html.md +2 -2
- data/doc_out/Organization.html.md +1 -0
- data/doc_out/OrganizationApi.html.md +70 -3
- data/doc_out/OrganizationPresenceEntityListing.html.md +2 -2
- data/doc_out/OrganizationRoleEntityListing.html.md +2 -2
- data/doc_out/OrphanRecordingListing.html.md +2 -2
- data/doc_out/OutOfOfficeNotification.html.md +1 -1
- data/doc_out/OutboundApi.html.md +323 -95
- data/doc_out/OutboundRouteBaseEntityListing.html.md +2 -2
- data/doc_out/OutboundRouteEntityListing.html.md +2 -2
- data/doc_out/PermissionCollectionEntityListing.html.md +2 -2
- data/doc_out/PhoneBaseEntityListing.html.md +2 -2
- data/doc_out/PhoneEntityListing.html.md +2 -2
- data/doc_out/PhoneMetaBaseEntityListing.html.md +2 -2
- data/doc_out/PhysicalInterfaceEntityListing.html.md +2 -2
- data/doc_out/PolicyEntityListing.html.md +2 -2
- data/doc_out/PresenceApi.html.md +33 -9
- data/doc_out/QualityApi.html.md +128 -33
- data/doc_out/QualityAuditPage.html.md +2 -2
- data/doc_out/QueueEntityListing.html.md +2 -2
- data/doc_out/QueueMemberEntityListing.html.md +2 -2
- data/doc_out/RecordingApi.html.md +133 -34
- data/doc_out/RecordingDataV2Notification.html.md +29 -0
- data/doc_out/{RecordingDataNotificationConversationData.html.md → RecordingDataV2NotificationConversationData.html.md} +2 -2
- data/doc_out/RecordingDataV2NotificationLockData.html.md +15 -0
- data/doc_out/RecordingDataV2NotificationLockInfo.html.md +15 -0
- data/doc_out/{DocumentDataNotificationCreatedBy.html.md → RecordingDataV2NotificationUserData.html.md} +2 -2
- data/doc_out/{RecordingDataNotificationWorkspaceData.html.md → RecordingDataV2NotificationWorkspaceData.html.md} +2 -2
- data/doc_out/ReportMetaDataEntityListing.html.md +2 -2
- data/doc_out/ReportRunEntryEntityDomainListing.html.md +2 -2
- data/doc_out/ReportScheduleEntityListing.html.md +2 -2
- data/doc_out/ResponseEntityList.html.md +2 -2
- data/doc_out/ResponseEntityListing.html.md +2 -2
- data/doc_out/ResponseManagementApi.html.md +45 -12
- data/doc_out/ResponseSetEntityListing.html.md +2 -2
- data/doc_out/ResponseSetNotification.html.md +1 -1
- data/doc_out/RoutingApi.html.md +193 -49
- data/doc_out/RoutingStatusAlertContainer.html.md +2 -2
- data/doc_out/RoutingStatusRuleContainer.html.md +2 -2
- data/doc_out/RuleSetEntityListing.html.md +2 -2
- data/doc_out/RuleSetNotification.html.md +1 -1
- data/doc_out/RuleSetNotificationCondition.html.md +1 -1
- data/doc_out/RuleSetNotificationConditions.html.md +1 -1
- data/doc_out/SchemaCategoryEntityListing.html.md +2 -2
- data/doc_out/SchemaReferenceEntityListing.html.md +2 -2
- data/doc_out/ScreenRecordingSessionListing.html.md +2 -2
- data/doc_out/ScreenShareConversationNotificationParticipants.html.md +1 -1
- data/doc_out/ScreenShareConversationNotificationScreenShareMediaParticipant.html.md +1 -1
- data/doc_out/ScriptEntityListing.html.md +2 -2
- data/doc_out/ScriptsApi.html.md +37 -10
- data/doc_out/SearchApi.html.md +49 -13
- data/doc_out/SecurityProfileEntityListing.html.md +2 -2
- data/doc_out/SequenceScheduleNotification.html.md +2 -2
- data/doc_out/ShareEntityListing.html.md +2 -2
- data/doc_out/SiteEntityListing.html.md +2 -2
- data/doc_out/SkillEntityListing.html.md +2 -2
- data/doc_out/SocialConversationNotificationParticipants.html.md +1 -1
- data/doc_out/SocialConversationNotificationSocialMediaParticipant.html.md +1 -1
- data/doc_out/StationEntityListing.html.md +2 -2
- data/doc_out/StationsApi.html.md +13 -4
- data/doc_out/SuggestApi.html.md +17 -5
- data/doc_out/TagValueEntityListing.html.md +2 -2
- data/doc_out/TelephonyProvidersEdgeApi.html.md +479 -121
- data/doc_out/TimeZoneEntityListing.html.md +2 -2
- data/doc_out/TokensApi.html.md +5 -2
- data/doc_out/TrunkBaseEntityListing.html.md +2 -2
- data/doc_out/TrunkEntityListing.html.md +2 -2
- data/doc_out/TrunkMetabaseEntityListing.html.md +2 -2
- data/doc_out/UserEntityListing.html.md +2 -2
- data/doc_out/UserListScheduleRequestBody.html.md +15 -0
- data/doc_out/UserPresenceAlertContainer.html.md +2 -2
- data/doc_out/UserPresenceRuleContainer.html.md +2 -2
- data/doc_out/UserQueueEntityListing.html.md +2 -2
- data/doc_out/UserRecordingEntityListing.html.md +2 -2
- data/doc_out/UserRecordingsApi.html.md +25 -7
- data/doc_out/UserSchedule.html.md +14 -0
- data/doc_out/UserScheduleActivity.html.md +18 -0
- data/doc_out/UserScheduleContainer.html.md +14 -0
- data/doc_out/UserScheduleFullDayTimeOffMarker.html.md +17 -0
- data/doc_out/UserScheduleShift.html.md +15 -0
- data/doc_out/UserSkillEntityListing.html.md +2 -2
- data/doc_out/UsersApi.html.md +169 -43
- data/doc_out/UtilitiesApi.html.md +13 -4
- data/doc_out/VideoConversationNotificationParticipants.html.md +1 -1
- data/doc_out/VideoConversationNotificationVideoMediaParticipant.html.md +1 -1
- data/doc_out/VoicemailApi.html.md +89 -23
- data/doc_out/VoicemailMessageEntityListing.html.md +2 -2
- data/doc_out/WfmUserEntityListing.html.md +13 -0
- data/doc_out/WorkforceManagementApi.html.md +227 -13
- data/doc_out/WorkspaceEntityListing.html.md +2 -2
- data/doc_out/WorkspaceMemberEntityListing.html.md +2 -2
- data/doc_out/WrapUpCodeMappingNotification.html.md +0 -1
- data/doc_out/WrapupCodeEntityListing.html.md +2 -2
- data/doc_out/index.html.md +3 -3
- data/lib/purecloud.rb +34 -20
- data/lib/purecloud/api/conversations_api.rb +120 -0
- data/lib/purecloud/api/organization_api.rb +57 -0
- data/lib/purecloud/api/outbound_api.rb +9 -9
- data/lib/purecloud/api/quality_api.rb +7 -0
- data/lib/purecloud/api/telephony_providers_edge_api.rb +3 -1
- data/lib/purecloud/api/workforce_management_api.rb +185 -3
- data/lib/purecloud/api_client.rb +1 -1
- data/lib/purecloud/models/activity_code.rb +253 -0
- data/lib/purecloud/models/activity_code_container.rb +169 -0
- data/lib/purecloud/models/agent_activity_entity_listing.rb +17 -17
- data/lib/purecloud/models/attempt_limits_entity_listing.rb +17 -17
- data/lib/purecloud/models/attempt_limits_notification.rb +24 -14
- data/lib/purecloud/models/attribute_entity_listing.rb +17 -17
- data/lib/purecloud/models/calibration_entity_listing.rb +17 -17
- data/lib/purecloud/models/call_conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/call_conversation_notification_call_media_participant.rb +1 -1
- data/lib/purecloud/models/call_conversation_notification_participants.rb +1 -1
- data/lib/purecloud/models/callable_time_set_entity_listing.rb +17 -17
- data/lib/purecloud/models/callable_time_set_notification.rb +13 -13
- data/lib/purecloud/models/callback_conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/callback_conversation_notification_callback_media_participant.rb +1 -1
- data/lib/purecloud/models/callback_conversation_notification_participants.rb +1 -1
- data/lib/purecloud/models/campaign_entity_listing.rb +17 -17
- data/lib/purecloud/models/campaign_notification.rb +15 -15
- data/lib/purecloud/models/{campaign_notification_error.rb → campaign_notification_rest_error_detail.rb} +1 -1
- data/lib/purecloud/models/campaign_progress_notification.rb +1 -1
- data/lib/purecloud/models/campaign_rule_entity_listing.rb +17 -17
- data/lib/purecloud/models/campaign_rule_notification.rb +14 -14
- data/lib/purecloud/models/campaign_rule_notification_campaign_rule_action_entities.rb +2 -2
- data/lib/purecloud/models/campaign_rule_notification_campaign_rule_entities.rb +3 -13
- data/lib/purecloud/models/campaign_rule_notification_uri_reference.rb +175 -0
- data/lib/purecloud/models/campaign_schedule_notification.rb +14 -14
- data/lib/purecloud/models/campaign_sequence_entity_listing.rb +17 -17
- data/lib/purecloud/models/campaign_sequence_notification.rb +15 -15
- data/lib/purecloud/models/certificate_authority_entity_listing.rb +17 -17
- data/lib/purecloud/models/channel_entity_listing.rb +17 -17
- data/lib/purecloud/models/chat_conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/chat_conversation_notification_chat_media_participant.rb +1 -1
- data/lib/purecloud/models/chat_conversation_notification_participants.rb +1 -1
- data/lib/purecloud/models/cobrowse_conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/cobrowse_conversation_notification_cobrowse_media_participant.rb +1 -1
- data/lib/purecloud/models/cobrowse_conversation_notification_participants.rb +1 -1
- data/lib/purecloud/models/command_status_entity_listing.rb +17 -17
- data/lib/purecloud/models/contact_list_entity_listing.rb +17 -17
- data/lib/purecloud/models/contact_list_notification.rb +14 -14
- data/lib/purecloud/models/{contact_list_notification_phone_column_.rb → contact_list_notification_contact_phone_number_column.rb} +1 -1
- data/lib/purecloud/models/contact_list_notification_import_status.rb +1 -1
- data/lib/purecloud/models/conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/create_email_request.rb +280 -0
- data/lib/purecloud/models/create_web_chat_request.rb +236 -0
- data/lib/purecloud/models/decisions_file_metadata_entity_listing.rb +17 -17
- data/lib/purecloud/models/did_entity_listing.rb +17 -17
- data/lib/purecloud/models/did_pool_entity_listing.rb +17 -17
- data/lib/purecloud/models/dnc_list_entity_listing.rb +17 -17
- data/lib/purecloud/models/dnc_list_notification.rb +14 -14
- data/lib/purecloud/models/dnc_list_notification_import_status.rb +1 -1
- data/lib/purecloud/models/document_audit_entity_listing.rb +17 -17
- data/lib/purecloud/models/{document_data_notification.rb → document_data_v2_notification.rb} +9 -29
- data/lib/purecloud/models/{recording_data_notification_user_data.rb → document_data_v2_notification_created_by.rb} +1 -1
- data/lib/purecloud/models/{document_data_notification_lock_info.rb → document_data_v2_notification_lock_data.rb} +4 -4
- data/lib/purecloud/models/{document_data_notification_lock_data.rb → document_data_v2_notification_lock_info.rb} +4 -4
- data/lib/purecloud/models/{document_data_notification_user_data.rb → document_data_v2_notification_user_data.rb} +1 -1
- data/lib/purecloud/models/{document_data_notification_workspace.rb → document_data_v2_notification_workspace.rb} +1 -1
- data/lib/purecloud/models/{document_data_notification_workspace_data.rb → document_data_v2_notification_workspace_data.rb} +1 -1
- data/lib/purecloud/models/document_entity_listing.rb +17 -17
- data/lib/purecloud/models/domain_edge_software_version_dto_entity_listing.rb +17 -17
- data/lib/purecloud/models/domain_entity_listing.rb +17 -17
- data/lib/purecloud/models/domain_entity_listing_evaluation_form.rb +17 -17
- data/lib/purecloud/models/domain_entity_listing_query_result.rb +17 -17
- data/lib/purecloud/models/domain_organization_role.rb +11 -11
- data/lib/purecloud/models/domain_organization_role_create.rb +11 -11
- data/lib/purecloud/models/domain_organization_role_update.rb +11 -11
- data/lib/purecloud/models/edge_entity_listing.rb +17 -17
- data/lib/purecloud/models/edge_group_entity_listing.rb +17 -17
- data/lib/purecloud/models/edge_line_entity_listing.rb +17 -17
- data/lib/purecloud/models/edge_reboot_parameters.rb +166 -0
- data/lib/purecloud/models/email_conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/email_conversation_notification_email_media_participant.rb +1 -1
- data/lib/purecloud/models/email_conversation_notification_participants.rb +1 -1
- data/lib/purecloud/models/email_message_listing.rb +17 -17
- data/lib/purecloud/models/encryption_key_entity_listing.rb +17 -17
- data/lib/purecloud/models/endpoint_entity_listing.rb +17 -17
- data/lib/purecloud/models/entry.rb +8 -10
- data/lib/purecloud/models/entry_feature_boolean.rb +184 -0
- data/lib/purecloud/models/evaluation_entity_listing.rb +17 -17
- data/lib/purecloud/models/evaluation_form_entity_listing.rb +17 -17
- data/lib/purecloud/models/evaluator_activity_entity_listing.rb +17 -17
- data/lib/purecloud/models/extension_entity_listing.rb +17 -17
- data/lib/purecloud/models/extension_pool_entity_listing.rb +17 -17
- data/lib/purecloud/models/{fax_data_notification.rb → fax_data_v2_notification.rb} +9 -29
- data/lib/purecloud/models/{fax_data_notification_lock_info.rb → fax_data_v2_notification_lock_data.rb} +4 -4
- data/lib/purecloud/models/{fax_data_notification_lock_data.rb → fax_data_v2_notification_lock_info.rb} +4 -4
- data/lib/purecloud/models/{fax_data_notification_user_data.rb → fax_data_v2_notification_user_data.rb} +1 -1
- data/lib/purecloud/models/{fax_data_notification_workspace_data.rb → fax_data_v2_notification_workspace_data.rb} +1 -1
- data/lib/purecloud/models/fax_document_entity_listing.rb +17 -17
- data/lib/purecloud/models/greeting_listing.rb +17 -17
- data/lib/purecloud/models/group_entity_listing.rb +17 -17
- data/lib/purecloud/models/heart_beat_alert_container.rb +17 -17
- data/lib/purecloud/models/heart_beat_rule_container.rb +17 -17
- data/lib/purecloud/models/import_status_notification.rb +1 -1
- data/lib/purecloud/models/inbound_domain_entity_listing.rb +17 -17
- data/lib/purecloud/models/inbound_route_entity_listing.rb +17 -17
- data/lib/purecloud/models/interaction_stats_alert_container.rb +17 -17
- data/lib/purecloud/models/interaction_stats_rule_container.rb +17 -17
- data/lib/purecloud/models/json_node.rb +24 -24
- data/lib/purecloud/models/keyword_set_entity_listing.rb +17 -17
- data/lib/purecloud/models/language_entity_listing.rb +17 -17
- data/lib/purecloud/models/library_entity_listing.rb +17 -17
- data/lib/purecloud/models/line_base_entity_listing.rb +17 -17
- data/lib/purecloud/models/line_entity_listing.rb +17 -17
- data/lib/purecloud/models/local_encryption_configuration_listing.rb +17 -17
- data/lib/purecloud/models/logical_interface_entity_listing.rb +17 -17
- data/lib/purecloud/models/o_auth_client_entity_listing.rb +17 -17
- data/lib/purecloud/models/o_auth_provider_entity_listing.rb +17 -17
- data/lib/purecloud/models/organization.rb +17 -4
- data/lib/purecloud/models/organization_presence_entity_listing.rb +17 -17
- data/lib/purecloud/models/organization_role_entity_listing.rb +17 -17
- data/lib/purecloud/models/orphan_recording_listing.rb +17 -17
- data/lib/purecloud/models/out_of_office_notification.rb +1 -1
- data/lib/purecloud/models/outbound_route_base_entity_listing.rb +17 -17
- data/lib/purecloud/models/outbound_route_entity_listing.rb +17 -17
- data/lib/purecloud/models/permission_collection_entity_listing.rb +17 -17
- data/lib/purecloud/models/phone_base_entity_listing.rb +17 -17
- data/lib/purecloud/models/phone_entity_listing.rb +17 -17
- data/lib/purecloud/models/phone_meta_base_entity_listing.rb +17 -17
- data/lib/purecloud/models/physical_interface_entity_listing.rb +17 -17
- data/lib/purecloud/models/policy_entity_listing.rb +17 -17
- data/lib/purecloud/models/quality_audit_page.rb +17 -17
- data/lib/purecloud/models/queue_entity_listing.rb +17 -17
- data/lib/purecloud/models/queue_member_entity_listing.rb +17 -17
- data/lib/purecloud/models/{recording_data_notification.rb → recording_data_v2_notification.rb} +10 -30
- data/lib/purecloud/models/{recording_data_notification_conversation_data.rb → recording_data_v2_notification_conversation_data.rb} +1 -1
- data/lib/purecloud/models/recording_data_v2_notification_lock_data.rb +185 -0
- data/lib/purecloud/models/recording_data_v2_notification_lock_info.rb +185 -0
- data/lib/purecloud/models/{document_data_notification_created_by.rb → recording_data_v2_notification_user_data.rb} +1 -1
- data/lib/purecloud/models/{recording_data_notification_workspace_data.rb → recording_data_v2_notification_workspace_data.rb} +1 -1
- data/lib/purecloud/models/report_meta_data_entity_listing.rb +17 -17
- data/lib/purecloud/models/report_run_entry_entity_domain_listing.rb +17 -17
- data/lib/purecloud/models/report_schedule_entity_listing.rb +17 -17
- data/lib/purecloud/models/response_entity_list.rb +17 -17
- data/lib/purecloud/models/response_entity_listing.rb +17 -17
- data/lib/purecloud/models/response_set_entity_listing.rb +17 -17
- data/lib/purecloud/models/response_set_notification.rb +13 -13
- data/lib/purecloud/models/routing_status_alert_container.rb +17 -17
- data/lib/purecloud/models/routing_status_rule_container.rb +17 -17
- data/lib/purecloud/models/rule_set_entity_listing.rb +17 -17
- data/lib/purecloud/models/rule_set_notification.rb +1 -1
- data/lib/purecloud/models/rule_set_notification_condition.rb +11 -11
- data/lib/purecloud/models/rule_set_notification_conditions.rb +18 -18
- data/lib/purecloud/models/rule_set_notification_rule.rb +9 -0
- data/lib/purecloud/models/rule_set_notification_rules.rb +9 -0
- data/lib/purecloud/models/schema_category_entity_listing.rb +17 -17
- data/lib/purecloud/models/schema_reference_entity_listing.rb +17 -17
- data/lib/purecloud/models/screen_recording_session_listing.rb +17 -17
- data/lib/purecloud/models/screen_share_conversation_notification_participants.rb +1 -1
- data/lib/purecloud/models/screen_share_conversation_notification_screen_share_media_participant.rb +1 -1
- data/lib/purecloud/models/script_entity_listing.rb +17 -17
- data/lib/purecloud/models/security_profile_entity_listing.rb +17 -17
- data/lib/purecloud/models/sequence_schedule_notification.rb +14 -14
- data/lib/purecloud/models/share_entity_listing.rb +17 -17
- data/lib/purecloud/models/site_entity_listing.rb +17 -17
- data/lib/purecloud/models/skill_entity_listing.rb +17 -17
- data/lib/purecloud/models/social_conversation_notification_participants.rb +1 -1
- data/lib/purecloud/models/social_conversation_notification_social_media_participant.rb +1 -1
- data/lib/purecloud/models/station_entity_listing.rb +17 -17
- data/lib/purecloud/models/tag_value_entity_listing.rb +17 -17
- data/lib/purecloud/models/time_zone_entity_listing.rb +17 -17
- data/lib/purecloud/models/trunk_base_entity_listing.rb +17 -17
- data/lib/purecloud/models/trunk_entity_listing.rb +17 -17
- data/lib/purecloud/models/trunk_metabase_entity_listing.rb +17 -17
- data/lib/purecloud/models/user_entity_listing.rb +17 -17
- data/lib/purecloud/models/user_list_schedule_request_body.rb +191 -0
- data/lib/purecloud/models/user_presence_alert_container.rb +17 -17
- data/lib/purecloud/models/user_presence_rule_container.rb +17 -17
- data/lib/purecloud/models/user_queue_entity_listing.rb +17 -17
- data/lib/purecloud/models/user_recording_entity_listing.rb +17 -17
- data/lib/purecloud/models/user_schedule.rb +182 -0
- data/lib/purecloud/models/user_schedule_activity.rb +222 -0
- data/lib/purecloud/models/user_schedule_container.rb +180 -0
- data/lib/purecloud/models/user_schedule_full_day_time_off_marker.rb +211 -0
- data/lib/purecloud/models/user_schedule_shift.rb +191 -0
- data/lib/purecloud/models/user_skill_entity_listing.rb +17 -17
- data/lib/purecloud/models/video_conversation_notification_participants.rb +1 -1
- data/lib/purecloud/models/video_conversation_notification_video_media_participant.rb +1 -1
- data/lib/purecloud/models/voicemail_message_entity_listing.rb +17 -17
- data/lib/purecloud/models/wfm_user_entity_listing.rb +167 -0
- data/lib/purecloud/models/workspace_entity_listing.rb +17 -17
- data/lib/purecloud/models/workspace_member_entity_listing.rb +17 -17
- data/lib/purecloud/models/wrap_up_code_mapping_notification.rb +4 -14
- data/lib/purecloud/models/wrapup_code_entity_listing.rb +17 -17
- data/lib/purecloud/version.rb +1 -1
- data/newVersion.md +1 -1
- data/swagger.json +1 -1
- data/swagger_template/api_doc.mustache +5 -2
- data/version.json +1 -1
- metadata +70 -42
- data/doc_out/DocumentDataNotification.html.md +0 -28
- data/doc_out/DocumentDataNotificationLockData.html.md +0 -15
- data/doc_out/DocumentDataNotificationLockInfo.html.md +0 -15
- data/doc_out/FaxDataNotification.html.md +0 -31
- data/doc_out/FaxDataNotificationLockData.html.md +0 -15
- data/doc_out/FaxDataNotificationLockInfo.html.md +0 -15
- data/doc_out/RecordingDataNotification.html.md +0 -31
- data/doc_out/RecordingDataNotificationLockData.html.md +0 -15
- data/doc_out/RecordingDataNotificationLockInfo.html.md +0 -15
- data/lib/purecloud/models/recording_data_notification_lock_data.rb +0 -185
- data/lib/purecloud/models/recording_data_notification_lock_info.rb +0 -185
|
@@ -11,11 +11,11 @@ title: CalibrationEntityListing
|
|
|
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: CallConversationEntityListing
|
|
|
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
|
|
|
@@ -21,7 +21,7 @@ title: CallConversationNotificationCallMediaParticipant
|
|
|
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** | [**CallConversationNotificationUriReference**](CallConversationNotificationUriReference.html) | | [optional] |
|
|
26
26
|
| **attributes** | **Hash<String, String>** | | [optional] |
|
|
27
27
|
| **error_info** | [**CallConversationNotificationErrorInfo**](CallConversationNotificationErrorInfo.html) | | [optional] |
|
|
@@ -40,7 +40,7 @@ title: CallConversationNotificationParticipants
|
|
|
40
40
|
| **recording_state** | **String** | | [optional] |
|
|
41
41
|
| **attributes** | **Hash<String, String>** | | [optional] |
|
|
42
42
|
| **group** | [**CallConversationNotificationUriReference**](CallConversationNotificationUriReference.html) | | [optional] |
|
|
43
|
-
| **user** | [**
|
|
43
|
+
| **user** | [**DocumentDataV2NotificationCreatedBy**](DocumentDataV2NotificationCreatedBy.html) | | [optional] |
|
|
44
44
|
| **document_id** | **String** | | [optional] |
|
|
45
45
|
{: class="table table-striped"}
|
|
46
46
|
|
|
@@ -11,11 +11,11 @@ title: CallableTimeSetEntityListing
|
|
|
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: CallableTimeSetNotification
|
|
|
12
12
|
| **date_created** | **DateTime** | | [optional] |
|
|
13
13
|
| **date_modified** | **DateTime** | | [optional] |
|
|
14
14
|
| **version** | **Integer** | | [optional] |
|
|
15
|
-
| **additional_properties** | **Object** | | [optional] |
|
|
16
15
|
| **callable_times** | [**Array<CallableTimeSetNotificationCallableTimes>**](CallableTimeSetNotificationCallableTimes.html) | | [optional] |
|
|
16
|
+
| **additional_properties** | **Object** | | [optional] |
|
|
17
17
|
{: class="table table-striped"}
|
|
18
18
|
|
|
19
19
|
|
|
@@ -11,11 +11,11 @@ title: CallbackConversationEntityListing
|
|
|
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
|
|
|
@@ -21,7 +21,7 @@ title: CallbackConversationNotificationCallbackMediaParticipant
|
|
|
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** | [**CallbackConversationNotificationUriReference**](CallbackConversationNotificationUriReference.html) | | [optional] |
|
|
26
26
|
| **attributes** | **Hash<String, String>** | | [optional] |
|
|
27
27
|
| **error_info** | [**CallbackConversationNotificationErrorInfo**](CallbackConversationNotificationErrorInfo.html) | | [optional] |
|
|
@@ -36,7 +36,7 @@ title: CallbackConversationNotificationParticipants
|
|
|
36
36
|
| **outbound_preview** | [**ConversationNotificationDialerPreview**](ConversationNotificationDialerPreview.html) | | [optional] |
|
|
37
37
|
| **attributes** | **Hash<String, String>** | | [optional] |
|
|
38
38
|
| **automated_callback_config_id** | **String** | | [optional] |
|
|
39
|
-
| **user** | [**
|
|
39
|
+
| **user** | [**DocumentDataV2NotificationCreatedBy**](DocumentDataV2NotificationCreatedBy.html) | | [optional] |
|
|
40
40
|
| **callback_user_name** | **String** | | [optional] |
|
|
41
41
|
{: class="table table-striped"}
|
|
42
42
|
|
|
@@ -11,11 +11,11 @@ title: CampaignEntityListing
|
|
|
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,7 @@ title: CampaignNotification
|
|
|
12
12
|
| **date_created** | **DateTime** | | [optional] |
|
|
13
13
|
| **date_modified** | **DateTime** | | [optional] |
|
|
14
14
|
| **version** | **Integer** | | [optional] |
|
|
15
|
-
| **
|
|
16
|
-
| **contact_list** | [**DocumentDataNotificationCreatedBy**](DocumentDataNotificationCreatedBy.html) | | [optional] |
|
|
15
|
+
| **contact_list** | [**DocumentDataV2NotificationCreatedBy**](DocumentDataV2NotificationCreatedBy.html) | | [optional] |
|
|
17
16
|
| **queue** | [**CampaignNotificationUriReference**](CampaignNotificationUriReference.html) | | [optional] |
|
|
18
17
|
| **dialing_mode** | **String** | | [optional] |
|
|
19
18
|
| **script** | [**CampaignNotificationUriReference**](CampaignNotificationUriReference.html) | | [optional] |
|
|
@@ -36,6 +35,7 @@ title: CampaignNotification
|
|
|
36
35
|
| **no_answer_timeout** | **Integer** | | [optional] |
|
|
37
36
|
| **call_analysis_language** | **String** | | [optional] |
|
|
38
37
|
| **priority** | **Integer** | | [optional] |
|
|
38
|
+
| **additional_properties** | **Object** | | [optional] |
|
|
39
39
|
{: class="table table-striped"}
|
|
40
40
|
|
|
41
41
|
|
|
@@ -7,7 +7,7 @@ title: CampaignProgressNotification
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **campaign** | [**
|
|
10
|
+
| **campaign** | [**DocumentDataV2NotificationCreatedBy**](DocumentDataV2NotificationCreatedBy.html) | | [optional] |
|
|
11
11
|
| **number_of_contacts_called** | **Float** | | [optional] |
|
|
12
12
|
| **total_number_of_contacts** | **Float** | | [optional] |
|
|
13
13
|
| **percentage** | **Integer** | | [optional] |
|
|
@@ -11,11 +11,11 @@ title: CampaignRuleEntityListing
|
|
|
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,12 +12,12 @@ title: CampaignRuleNotification
|
|
|
12
12
|
| **date_created** | **DateTime** | | [optional] |
|
|
13
13
|
| **date_modified** | **DateTime** | | [optional] |
|
|
14
14
|
| **version** | **Integer** | | [optional] |
|
|
15
|
-
| **additional_properties** | **Object** | | [optional] |
|
|
16
15
|
| **campaign_rule_entities** | [**CampaignRuleNotificationCampaignRuleEntities**](CampaignRuleNotificationCampaignRuleEntities.html) | | [optional] |
|
|
17
16
|
| **campaign_rule_conditions** | [**Array<CampaignRuleNotificationCampaignRuleConditions>**](CampaignRuleNotificationCampaignRuleConditions.html) | | [optional] |
|
|
18
17
|
| **campaign_rule_actions** | [**Array<CampaignRuleNotificationCampaignRuleActions>**](CampaignRuleNotificationCampaignRuleActions.html) | | [optional] |
|
|
19
18
|
| **match_any_conditions** | **BOOLEAN** | | [optional] |
|
|
20
19
|
| **enabled** | **BOOLEAN** | | [optional] |
|
|
20
|
+
| **additional_properties** | **Object** | | [optional] |
|
|
21
21
|
{: class="table table-striped"}
|
|
22
22
|
|
|
23
23
|
|
|
@@ -8,8 +8,8 @@ title: CampaignRuleNotificationCampaignRuleActionEntities
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
10
|
| **additional_properties** | **Object** | | [optional] |
|
|
11
|
-
| **sequences** | **Array<
|
|
12
|
-
| **campaigns** | **Array<
|
|
11
|
+
| **sequences** | [**Array<CampaignRuleNotificationUriReference>**](CampaignRuleNotificationUriReference.html) | | [optional] |
|
|
12
|
+
| **campaigns** | [**Array<CampaignRuleNotificationUriReference>**](CampaignRuleNotificationUriReference.html) | | [optional] |
|
|
13
13
|
| **use_triggering_entity** | **BOOLEAN** | | [optional] |
|
|
14
14
|
{: class="table table-striped"}
|
|
15
15
|
|
|
@@ -7,9 +7,8 @@ title: CampaignRuleNotificationCampaignRuleEntities
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **
|
|
11
|
-
| **
|
|
12
|
-
| **campaigns** | **Array<String>** | | [optional] |
|
|
10
|
+
| **sequences** | [**Array<CampaignRuleNotificationUriReference>**](CampaignRuleNotificationUriReference.html) | | [optional] |
|
|
11
|
+
| **campaigns** | [**Array<DocumentDataV2NotificationCreatedBy>**](DocumentDataV2NotificationCreatedBy.html) | | [optional] |
|
|
13
12
|
{: class="table table-striped"}
|
|
14
13
|
|
|
15
14
|
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: CampaignRuleNotificationUriReference
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::CampaignRuleNotificationUriReference
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **id** | **String** | | [optional] |
|
|
11
|
+
| **name** | **String** | | [optional] |
|
|
12
|
+
{: class="table table-striped"}
|
|
13
|
+
|
|
14
|
+
|
|
@@ -12,10 +12,10 @@ title: CampaignScheduleNotification
|
|
|
12
12
|
| **date_created** | **DateTime** | | [optional] |
|
|
13
13
|
| **date_modified** | **DateTime** | | [optional] |
|
|
14
14
|
| **version** | **Integer** | | [optional] |
|
|
15
|
-
| **additional_properties** | **Object** | | [optional] |
|
|
16
15
|
| **intervals** | [**Array<CampaignScheduleNotificationIntervals>**](CampaignScheduleNotificationIntervals.html) | | [optional] |
|
|
17
16
|
| **time_zone** | **String** | | [optional] |
|
|
18
|
-
| **campaign** | [**
|
|
17
|
+
| **campaign** | [**DocumentDataV2NotificationCreatedBy**](DocumentDataV2NotificationCreatedBy.html) | | [optional] |
|
|
18
|
+
| **additional_properties** | **Object** | | [optional] |
|
|
19
19
|
{: class="table table-striped"}
|
|
20
20
|
|
|
21
21
|
|
|
@@ -11,11 +11,11 @@ title: CampaignSequenceEntityListing
|
|
|
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,12 +12,12 @@ title: CampaignSequenceNotification
|
|
|
12
12
|
| **date_created** | **DateTime** | | [optional] |
|
|
13
13
|
| **date_modified** | **DateTime** | | [optional] |
|
|
14
14
|
| **version** | **Integer** | | [optional] |
|
|
15
|
-
| **
|
|
16
|
-
| **campaigns** | [**Array<DocumentDataNotificationCreatedBy>**](DocumentDataNotificationCreatedBy.html) | | [optional] |
|
|
15
|
+
| **campaigns** | [**Array<DocumentDataV2NotificationCreatedBy>**](DocumentDataV2NotificationCreatedBy.html) | | [optional] |
|
|
17
16
|
| **current_campaign** | **Integer** | | [optional] |
|
|
18
17
|
| **status** | **String** | | [optional] |
|
|
19
18
|
| **stop_message** | **String** | | [optional] |
|
|
20
19
|
| **repeat** | **BOOLEAN** | | [optional] |
|
|
20
|
+
| **additional_properties** | **Object** | | [optional] |
|
|
21
21
|
{: class="table table-striped"}
|
|
22
22
|
|
|
23
23
|
|
|
@@ -11,11 +11,11 @@ title: CertificateAuthorityEntityListing
|
|
|
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: ChannelEntityListing
|
|
|
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: ChatConversationEntityListing
|
|
|
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
|
|
|
@@ -21,7 +21,7 @@ title: ChatConversationNotificationChatMediaParticipant
|
|
|
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** | [**ChatConversationNotificationUriReference**](ChatConversationNotificationUriReference.html) | | [optional] |
|
|
26
26
|
| **attributes** | **Hash<String, String>** | | [optional] |
|
|
27
27
|
| **error_info** | [**ChatConversationNotificationErrorInfo**](ChatConversationNotificationErrorInfo.html) | | [optional] |
|
|
@@ -31,7 +31,7 @@ title: ChatConversationNotificationParticipants
|
|
|
31
31
|
| **wrapup_timeout_ms** | **Integer** | | [optional] |
|
|
32
32
|
| **external_organization** | [**ChatConversationNotificationUriReference**](ChatConversationNotificationUriReference.html) | | [optional] |
|
|
33
33
|
| **attributes** | **Hash<String, String>** | | [optional] |
|
|
34
|
-
| **user** | [**
|
|
34
|
+
| **user** | [**DocumentDataV2NotificationCreatedBy**](DocumentDataV2NotificationCreatedBy.html) | | [optional] |
|
|
35
35
|
{: class="table table-striped"}
|
|
36
36
|
|
|
37
37
|
|
|
@@ -11,11 +11,11 @@ title: CobrowseConversationEntityListing
|
|
|
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
|
|
|
@@ -21,7 +21,7 @@ title: CobrowseConversationNotificationCobrowseMediaParticipant
|
|
|
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** | [**CobrowseConversationNotificationUriReference**](CobrowseConversationNotificationUriReference.html) | | [optional] |
|
|
26
26
|
| **attributes** | **Hash<String, String>** | | [optional] |
|
|
27
27
|
| **error_info** | [**CobrowseConversationNotificationErrorInfo**](CobrowseConversationNotificationErrorInfo.html) | | [optional] |
|
|
@@ -35,7 +35,7 @@ title: CobrowseConversationNotificationParticipants
|
|
|
35
35
|
| **start_hold_time** | **DateTime** | | [optional] |
|
|
36
36
|
| **attributes** | **Hash<String, String>** | | [optional] |
|
|
37
37
|
| **viewer_url** | **String** | | [optional] |
|
|
38
|
-
| **user** | [**
|
|
38
|
+
| **user** | [**DocumentDataV2NotificationCreatedBy**](DocumentDataV2NotificationCreatedBy.html) | | [optional] |
|
|
39
39
|
{: class="table table-striped"}
|
|
40
40
|
|
|
41
41
|
|
|
@@ -11,11 +11,11 @@ title: CommandStatusEntityListing
|
|
|
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: ContactListEntityListing
|
|
|
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,14 +12,14 @@ title: ContactListNotification
|
|
|
12
12
|
| **date_created** | **DateTime** | | [optional] |
|
|
13
13
|
| **date_modified** | **DateTime** | | [optional] |
|
|
14
14
|
| **version** | **Integer** | | [optional] |
|
|
15
|
-
| **additional_properties** | **Object** | | [optional] |
|
|
16
15
|
| **column_names** | **Array<String>** | | [optional] |
|
|
17
16
|
| **phone_columns** | [**Array<ContactListNotificationPhoneColumns>**](ContactListNotificationPhoneColumns.html) | | [optional] |
|
|
18
17
|
| **import_status** | [**ContactListNotificationImportStatus**](ContactListNotificationImportStatus.html) | | [optional] |
|
|
19
18
|
| **preview_mode_column_name** | **String** | | [optional] |
|
|
20
19
|
| **preview_mode_accepted_values** | **Array<String>** | | [optional] |
|
|
21
20
|
| **size** | **Integer** | | [optional] |
|
|
22
|
-
| **attempt_limits** | [**
|
|
21
|
+
| **attempt_limits** | [**DocumentDataV2NotificationCreatedBy**](DocumentDataV2NotificationCreatedBy.html) | | [optional] |
|
|
22
|
+
| **additional_properties** | **Object** | | [optional] |
|
|
23
23
|
{: class="table table-striped"}
|
|
24
24
|
|
|
25
25
|
|
|
@@ -6,46 +6,46 @@ title: ContentManagementApi
|
|
|
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
|
-
|
|
11
|
+
[**delete_documents_document_id**](ContentManagementApi.html#delete_documents_document_id) | Delete a document.
|
|
12
|
+
[**delete_shares_share_id**](ContentManagementApi.html#delete_shares_share_id) | Deletes an existing share.
|
|
13
|
+
[**delete_status_status_id**](ContentManagementApi.html#delete_status_status_id) | Cancel the command for this status
|
|
14
|
+
[**delete_workspaces_workspace_id**](ContentManagementApi.html#delete_workspaces_workspace_id) | Delete a workspace
|
|
15
|
+
[**delete_workspaces_workspace_id_members_member_id**](ContentManagementApi.html#delete_workspaces_workspace_id_members_member_id) | Delete a member from a workspace
|
|
16
|
+
[**delete_workspaces_workspace_id_tagvalues_tag_id**](ContentManagementApi.html#delete_workspaces_workspace_id_tagvalues_tag_id) | Delete workspace tag
|
|
17
|
+
[**get_documents**](ContentManagementApi.html#get_documents) | Get a list of documents.
|
|
18
|
+
[**get_documents_document_id**](ContentManagementApi.html#get_documents_document_id) | Get a document.
|
|
19
|
+
[**get_documents_document_id_audits**](ContentManagementApi.html#get_documents_document_id_audits) | Get a list of audits for a document.
|
|
20
|
+
[**get_documents_document_id_content**](ContentManagementApi.html#get_documents_document_id_content) | Download a document.
|
|
21
|
+
[**get_query**](ContentManagementApi.html#get_query) | Query content
|
|
22
|
+
[**get_securityprofiles**](ContentManagementApi.html#get_securityprofiles) | Get a List of Security Profiles
|
|
23
|
+
[**get_securityprofiles_securityprofile_id**](ContentManagementApi.html#get_securityprofiles_securityprofile_id) | Get a Security Profile
|
|
24
|
+
[**get_shared_shared_id**](ContentManagementApi.html#get_shared_shared_id) | Get shared documents. Securely download a shared document.
|
|
25
|
+
[**get_shares**](ContentManagementApi.html#get_shares) | Gets a list of shares. You must specify at least one filter (e.g. entityId).
|
|
26
|
+
[**get_shares_share_id**](ContentManagementApi.html#get_shares_share_id) | Retrieve details about an existing share.
|
|
27
|
+
[**get_status**](ContentManagementApi.html#get_status) | Get a list of statuses for pending operations
|
|
28
|
+
[**get_status_status_id**](ContentManagementApi.html#get_status_status_id) | Get a status.
|
|
29
|
+
[**get_usage**](ContentManagementApi.html#get_usage) | Get usage details.
|
|
30
|
+
[**get_workspaces**](ContentManagementApi.html#get_workspaces) | Get a list of workspaces.
|
|
31
|
+
[**get_workspaces_workspace_id**](ContentManagementApi.html#get_workspaces_workspace_id) | Get a workspace.
|
|
32
|
+
[**get_workspaces_workspace_id_documents**](ContentManagementApi.html#get_workspaces_workspace_id_documents) | Get a list of documents.
|
|
33
|
+
[**get_workspaces_workspace_id_members**](ContentManagementApi.html#get_workspaces_workspace_id_members) | Get a list workspace members
|
|
34
|
+
[**get_workspaces_workspace_id_members_member_id**](ContentManagementApi.html#get_workspaces_workspace_id_members_member_id) | Get a workspace member
|
|
35
|
+
[**get_workspaces_workspace_id_tagvalues**](ContentManagementApi.html#get_workspaces_workspace_id_tagvalues) | Get a list of workspace tags
|
|
36
|
+
[**get_workspaces_workspace_id_tagvalues_tag_id**](ContentManagementApi.html#get_workspaces_workspace_id_tagvalues_tag_id) | Get a workspace tag
|
|
37
|
+
[**post_auditquery**](ContentManagementApi.html#post_auditquery) | Query audits
|
|
38
|
+
[**post_documents**](ContentManagementApi.html#post_documents) | Add a document.
|
|
39
|
+
[**post_documents_document_id**](ContentManagementApi.html#post_documents_document_id) | Update a document.
|
|
40
|
+
[**post_documents_document_id_content**](ContentManagementApi.html#post_documents_document_id_content) | Replace the contents of a document.
|
|
41
|
+
[**post_query**](ContentManagementApi.html#post_query) | Query content
|
|
42
|
+
[**post_shares**](ContentManagementApi.html#post_shares) | Creates a new share or updates an existing share if the entity has already been shared
|
|
43
|
+
[**post_workspaces**](ContentManagementApi.html#post_workspaces) | Create a group workspace
|
|
44
|
+
[**post_workspaces_workspace_id_tagvalues**](ContentManagementApi.html#post_workspaces_workspace_id_tagvalues) | Create a workspace tag
|
|
45
|
+
[**post_workspaces_workspace_id_tagvalues_query**](ContentManagementApi.html#post_workspaces_workspace_id_tagvalues_query) | Perform a prefix query on tags in the workspace
|
|
46
|
+
[**put_workspaces_workspace_id**](ContentManagementApi.html#put_workspaces_workspace_id) | Update a workspace
|
|
47
|
+
[**put_workspaces_workspace_id_members_member_id**](ContentManagementApi.html#put_workspaces_workspace_id_members_member_id) | Add a member to a workspace
|
|
48
|
+
[**put_workspaces_workspace_id_tagvalues_tag_id**](ContentManagementApi.html#put_workspaces_workspace_id_tagvalues_tag_id) | Update a workspace tag. Will update all documents with the new tag value.
|
|
49
49
|
{: class="table table-striped"}
|
|
50
50
|
|
|
51
51
|
<a name="delete_documents_document_id"></a>
|
|
@@ -56,6 +56,9 @@ Delete a document.
|
|
|
56
56
|
|
|
57
57
|
|
|
58
58
|
|
|
59
|
+
Wraps DELETE /api/v2/contentmanagement/documents/{documentId}
|
|
60
|
+
|
|
61
|
+
|
|
59
62
|
### Example
|
|
60
63
|
~~~ruby
|
|
61
64
|
# load the gem
|
|
@@ -115,6 +118,9 @@ Deletes an existing share.
|
|
|
115
118
|
|
|
116
119
|
This revokes sharing rights specified in the share record
|
|
117
120
|
|
|
121
|
+
Wraps DELETE /api/v2/contentmanagement/shares/{shareId}
|
|
122
|
+
|
|
123
|
+
|
|
118
124
|
### Example
|
|
119
125
|
~~~ruby
|
|
120
126
|
# load the gem
|
|
@@ -170,6 +176,9 @@ Cancel the command for this status
|
|
|
170
176
|
|
|
171
177
|
|
|
172
178
|
|
|
179
|
+
Wraps DELETE /api/v2/contentmanagement/status/{statusId}
|
|
180
|
+
|
|
181
|
+
|
|
173
182
|
### Example
|
|
174
183
|
~~~ruby
|
|
175
184
|
# load the gem
|
|
@@ -225,6 +234,9 @@ Delete a workspace
|
|
|
225
234
|
|
|
226
235
|
|
|
227
236
|
|
|
237
|
+
Wraps DELETE /api/v2/contentmanagement/workspaces/{workspaceId}
|
|
238
|
+
|
|
239
|
+
|
|
228
240
|
### Example
|
|
229
241
|
~~~ruby
|
|
230
242
|
# load the gem
|
|
@@ -284,6 +296,9 @@ Delete a member from a workspace
|
|
|
284
296
|
|
|
285
297
|
|
|
286
298
|
|
|
299
|
+
Wraps DELETE /api/v2/contentmanagement/workspaces/{workspaceId}/members/{memberId}
|
|
300
|
+
|
|
301
|
+
|
|
287
302
|
### Example
|
|
288
303
|
~~~ruby
|
|
289
304
|
# load the gem
|
|
@@ -342,6 +357,9 @@ Delete workspace tag
|
|
|
342
357
|
|
|
343
358
|
Delete a tag from a workspace. Will remove this tag from all documents.
|
|
344
359
|
|
|
360
|
+
Wraps DELETE /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId}
|
|
361
|
+
|
|
362
|
+
|
|
345
363
|
### Example
|
|
346
364
|
~~~ruby
|
|
347
365
|
# load the gem
|
|
@@ -400,6 +418,9 @@ Get a list of documents.
|
|
|
400
418
|
|
|
401
419
|
|
|
402
420
|
|
|
421
|
+
Wraps GET /api/v2/contentmanagement/documents
|
|
422
|
+
|
|
423
|
+
|
|
403
424
|
### Example
|
|
404
425
|
~~~ruby
|
|
405
426
|
# load the gem
|
|
@@ -470,6 +491,9 @@ Get a document.
|
|
|
470
491
|
|
|
471
492
|
|
|
472
493
|
|
|
494
|
+
Wraps GET /api/v2/contentmanagement/documents/{documentId}
|
|
495
|
+
|
|
496
|
+
|
|
473
497
|
### Example
|
|
474
498
|
~~~ruby
|
|
475
499
|
# load the gem
|
|
@@ -530,6 +554,9 @@ Get a list of audits for a document.
|
|
|
530
554
|
|
|
531
555
|
|
|
532
556
|
|
|
557
|
+
Wraps GET /api/v2/contentmanagement/documents/{documentId}/audits
|
|
558
|
+
|
|
559
|
+
|
|
533
560
|
### Example
|
|
534
561
|
~~~ruby
|
|
535
562
|
# load the gem
|
|
@@ -600,6 +627,9 @@ Download a document.
|
|
|
600
627
|
|
|
601
628
|
|
|
602
629
|
|
|
630
|
+
Wraps GET /api/v2/contentmanagement/documents/{documentId}/content
|
|
631
|
+
|
|
632
|
+
|
|
603
633
|
### Example
|
|
604
634
|
~~~ruby
|
|
605
635
|
# load the gem
|
|
@@ -662,6 +692,9 @@ Query content
|
|
|
662
692
|
|
|
663
693
|
|
|
664
694
|
|
|
695
|
+
Wraps GET /api/v2/contentmanagement/query
|
|
696
|
+
|
|
697
|
+
|
|
665
698
|
### Example
|
|
666
699
|
~~~ruby
|
|
667
700
|
# load the gem
|
|
@@ -730,6 +763,9 @@ Get a List of Security Profiles
|
|
|
730
763
|
|
|
731
764
|
|
|
732
765
|
|
|
766
|
+
Wraps GET /api/v2/contentmanagement/securityprofiles
|
|
767
|
+
|
|
768
|
+
|
|
733
769
|
### Example
|
|
734
770
|
~~~ruby
|
|
735
771
|
# load the gem
|
|
@@ -780,6 +816,9 @@ Get a Security Profile
|
|
|
780
816
|
|
|
781
817
|
|
|
782
818
|
|
|
819
|
+
Wraps GET /api/v2/contentmanagement/securityprofiles/{securityProfileId}
|
|
820
|
+
|
|
821
|
+
|
|
783
822
|
### Example
|
|
784
823
|
~~~ruby
|
|
785
824
|
# load the gem
|
|
@@ -836,6 +875,9 @@ Get shared documents. Securely download a shared document.
|
|
|
836
875
|
|
|
837
876
|
This method requires the download sharing URI obtained in the get document response (downloadSharingUri). Documents may be shared between users in the same workspace. Documents may also be shared between any user by creating a content management share.
|
|
838
877
|
|
|
878
|
+
Wraps GET /api/v2/contentmanagement/shared/{sharedId}
|
|
879
|
+
|
|
880
|
+
|
|
839
881
|
### Example
|
|
840
882
|
~~~ruby
|
|
841
883
|
# load the gem
|
|
@@ -902,6 +944,9 @@ Gets a list of shares. You must specify at least one filter (e.g. entityId).
|
|
|
902
944
|
|
|
903
945
|
Failing to specify a filter will return 400.
|
|
904
946
|
|
|
947
|
+
Wraps GET /api/v2/contentmanagement/shares
|
|
948
|
+
|
|
949
|
+
|
|
905
950
|
### Example
|
|
906
951
|
~~~ruby
|
|
907
952
|
# load the gem
|
|
@@ -965,6 +1010,9 @@ Retrieve details about an existing share.
|
|
|
965
1010
|
|
|
966
1011
|
|
|
967
1012
|
|
|
1013
|
+
Wraps GET /api/v2/contentmanagement/shares/{shareId}
|
|
1014
|
+
|
|
1015
|
+
|
|
968
1016
|
### Example
|
|
969
1017
|
~~~ruby
|
|
970
1018
|
# load the gem
|
|
@@ -1025,6 +1073,9 @@ Get a list of statuses for pending operations
|
|
|
1025
1073
|
|
|
1026
1074
|
|
|
1027
1075
|
|
|
1076
|
+
Wraps GET /api/v2/contentmanagement/status
|
|
1077
|
+
|
|
1078
|
+
|
|
1028
1079
|
### Example
|
|
1029
1080
|
~~~ruby
|
|
1030
1081
|
# load the gem
|
|
@@ -1084,6 +1135,9 @@ Get a status.
|
|
|
1084
1135
|
|
|
1085
1136
|
|
|
1086
1137
|
|
|
1138
|
+
Wraps GET /api/v2/contentmanagement/status/{statusId}
|
|
1139
|
+
|
|
1140
|
+
|
|
1087
1141
|
### Example
|
|
1088
1142
|
~~~ruby
|
|
1089
1143
|
# load the gem
|
|
@@ -1140,6 +1194,9 @@ Get usage details.
|
|
|
1140
1194
|
|
|
1141
1195
|
|
|
1142
1196
|
|
|
1197
|
+
Wraps GET /api/v2/contentmanagement/usage
|
|
1198
|
+
|
|
1199
|
+
|
|
1143
1200
|
### Example
|
|
1144
1201
|
~~~ruby
|
|
1145
1202
|
# load the gem
|
|
@@ -1190,6 +1247,9 @@ Get a list of workspaces.
|
|
|
1190
1247
|
|
|
1191
1248
|
Specifying 'content' access will return all workspaces the user has document access to, while 'admin' access will return all group workspaces the user has administrative rights to.
|
|
1192
1249
|
|
|
1250
|
+
Wraps GET /api/v2/contentmanagement/workspaces
|
|
1251
|
+
|
|
1252
|
+
|
|
1193
1253
|
### Example
|
|
1194
1254
|
~~~ruby
|
|
1195
1255
|
# load the gem
|
|
@@ -1253,6 +1313,9 @@ Get a workspace.
|
|
|
1253
1313
|
|
|
1254
1314
|
|
|
1255
1315
|
|
|
1316
|
+
Wraps GET /api/v2/contentmanagement/workspaces/{workspaceId}
|
|
1317
|
+
|
|
1318
|
+
|
|
1256
1319
|
### Example
|
|
1257
1320
|
~~~ruby
|
|
1258
1321
|
# load the gem
|
|
@@ -1313,6 +1376,9 @@ Get a list of documents.
|
|
|
1313
1376
|
|
|
1314
1377
|
|
|
1315
1378
|
|
|
1379
|
+
Wraps GET /api/v2/contentmanagement/workspaces/{workspaceId}/documents
|
|
1380
|
+
|
|
1381
|
+
|
|
1316
1382
|
### Example
|
|
1317
1383
|
~~~ruby
|
|
1318
1384
|
# load the gem
|
|
@@ -1381,6 +1447,9 @@ Get a list workspace members
|
|
|
1381
1447
|
|
|
1382
1448
|
|
|
1383
1449
|
|
|
1450
|
+
Wraps GET /api/v2/contentmanagement/workspaces/{workspaceId}/members
|
|
1451
|
+
|
|
1452
|
+
|
|
1384
1453
|
### Example
|
|
1385
1454
|
~~~ruby
|
|
1386
1455
|
# load the gem
|
|
@@ -1445,6 +1514,9 @@ Get a workspace member
|
|
|
1445
1514
|
|
|
1446
1515
|
|
|
1447
1516
|
|
|
1517
|
+
Wraps GET /api/v2/contentmanagement/workspaces/{workspaceId}/members/{memberId}
|
|
1518
|
+
|
|
1519
|
+
|
|
1448
1520
|
### Example
|
|
1449
1521
|
~~~ruby
|
|
1450
1522
|
# load the gem
|
|
@@ -1508,6 +1580,9 @@ Get a list of workspace tags
|
|
|
1508
1580
|
|
|
1509
1581
|
|
|
1510
1582
|
|
|
1583
|
+
Wraps GET /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues
|
|
1584
|
+
|
|
1585
|
+
|
|
1511
1586
|
### Example
|
|
1512
1587
|
~~~ruby
|
|
1513
1588
|
# load the gem
|
|
@@ -1574,6 +1649,9 @@ Get a workspace tag
|
|
|
1574
1649
|
|
|
1575
1650
|
|
|
1576
1651
|
|
|
1652
|
+
Wraps GET /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId}
|
|
1653
|
+
|
|
1654
|
+
|
|
1577
1655
|
### Example
|
|
1578
1656
|
~~~ruby
|
|
1579
1657
|
# load the gem
|
|
@@ -1637,6 +1715,9 @@ Query audits
|
|
|
1637
1715
|
|
|
1638
1716
|
|
|
1639
1717
|
|
|
1718
|
+
Wraps POST /api/v2/contentmanagement/auditquery
|
|
1719
|
+
|
|
1720
|
+
|
|
1640
1721
|
### Example
|
|
1641
1722
|
~~~ruby
|
|
1642
1723
|
# load the gem
|
|
@@ -1693,6 +1774,9 @@ Add a document.
|
|
|
1693
1774
|
|
|
1694
1775
|
|
|
1695
1776
|
|
|
1777
|
+
Wraps POST /api/v2/contentmanagement/documents
|
|
1778
|
+
|
|
1779
|
+
|
|
1696
1780
|
### Example
|
|
1697
1781
|
~~~ruby
|
|
1698
1782
|
# load the gem
|
|
@@ -1757,6 +1841,9 @@ Update a document.
|
|
|
1757
1841
|
|
|
1758
1842
|
|
|
1759
1843
|
|
|
1844
|
+
Wraps POST /api/v2/contentmanagement/documents/{documentId}
|
|
1845
|
+
|
|
1846
|
+
|
|
1760
1847
|
### Example
|
|
1761
1848
|
~~~ruby
|
|
1762
1849
|
# load the gem
|
|
@@ -1822,6 +1909,9 @@ Replace the contents of a document.
|
|
|
1822
1909
|
|
|
1823
1910
|
|
|
1824
1911
|
|
|
1912
|
+
Wraps POST /api/v2/contentmanagement/documents/{documentId}/content
|
|
1913
|
+
|
|
1914
|
+
|
|
1825
1915
|
### Example
|
|
1826
1916
|
~~~ruby
|
|
1827
1917
|
# load the gem
|
|
@@ -1885,6 +1975,9 @@ Query content
|
|
|
1885
1975
|
|
|
1886
1976
|
|
|
1887
1977
|
|
|
1978
|
+
Wraps POST /api/v2/contentmanagement/query
|
|
1979
|
+
|
|
1980
|
+
|
|
1888
1981
|
### Example
|
|
1889
1982
|
~~~ruby
|
|
1890
1983
|
# load the gem
|
|
@@ -1945,6 +2038,9 @@ Creates a new share or updates an existing share if the entity has already been
|
|
|
1945
2038
|
|
|
1946
2039
|
|
|
1947
2040
|
|
|
2041
|
+
Wraps POST /api/v2/contentmanagement/shares
|
|
2042
|
+
|
|
2043
|
+
|
|
1948
2044
|
### Example
|
|
1949
2045
|
~~~ruby
|
|
1950
2046
|
# load the gem
|
|
@@ -2001,6 +2097,9 @@ Create a group workspace
|
|
|
2001
2097
|
|
|
2002
2098
|
|
|
2003
2099
|
|
|
2100
|
+
Wraps POST /api/v2/contentmanagement/workspaces
|
|
2101
|
+
|
|
2102
|
+
|
|
2004
2103
|
### Example
|
|
2005
2104
|
~~~ruby
|
|
2006
2105
|
# load the gem
|
|
@@ -2057,6 +2156,9 @@ Create a workspace tag
|
|
|
2057
2156
|
|
|
2058
2157
|
|
|
2059
2158
|
|
|
2159
|
+
Wraps POST /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues
|
|
2160
|
+
|
|
2161
|
+
|
|
2060
2162
|
### Example
|
|
2061
2163
|
~~~ruby
|
|
2062
2164
|
# load the gem
|
|
@@ -2116,6 +2218,9 @@ Perform a prefix query on tags in the workspace
|
|
|
2116
2218
|
|
|
2117
2219
|
|
|
2118
2220
|
|
|
2221
|
+
Wraps POST /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/query
|
|
2222
|
+
|
|
2223
|
+
|
|
2119
2224
|
### Example
|
|
2120
2225
|
~~~ruby
|
|
2121
2226
|
# load the gem
|
|
@@ -2179,6 +2284,9 @@ Update a workspace
|
|
|
2179
2284
|
|
|
2180
2285
|
|
|
2181
2286
|
|
|
2287
|
+
Wraps PUT /api/v2/contentmanagement/workspaces/{workspaceId}
|
|
2288
|
+
|
|
2289
|
+
|
|
2182
2290
|
### Example
|
|
2183
2291
|
~~~ruby
|
|
2184
2292
|
# load the gem
|
|
@@ -2238,6 +2346,9 @@ Add a member to a workspace
|
|
|
2238
2346
|
|
|
2239
2347
|
|
|
2240
2348
|
|
|
2349
|
+
Wraps PUT /api/v2/contentmanagement/workspaces/{workspaceId}/members/{memberId}
|
|
2350
|
+
|
|
2351
|
+
|
|
2241
2352
|
### Example
|
|
2242
2353
|
~~~ruby
|
|
2243
2354
|
# load the gem
|
|
@@ -2300,6 +2411,9 @@ Update a workspace tag. Will update all documents with the new tag value.
|
|
|
2300
2411
|
|
|
2301
2412
|
|
|
2302
2413
|
|
|
2414
|
+
Wraps PUT /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId}
|
|
2415
|
+
|
|
2416
|
+
|
|
2303
2417
|
### Example
|
|
2304
2418
|
~~~ruby
|
|
2305
2419
|
# load the gem
|