Удалите определенные документы в DocuSign, используя идентификатор конверта (Assembly DocuSign.eSign)

Question

Я использую DocuSign.eSign DLL в C #. Я хочу удалить документы (Конверт) из Docusign

Я использовал метод, предоставляемый классом «EnvelopesApi», например «DeleteDocuments». Но это по сути удаление документа из черновика, но я хочу удалить любой конверт, сгенерированный в docusign.

EnvelopeDefinition envelopeDefinition = new EnvelopeDefinition
    {
        EnvelopeId = envelopId
    };
    envelopesApi.DeleteDocuments(accountId, envelopId,                                                          
 envelopeDefinition);

После вызова этого метода я ожидаю, что документы (конверт) будут удалены из DocuSign, но я пока не могу получить документы, используя метод "ListDocuments". пожалуйста, дайте мне знать, что мне не хватает.

Answer 1

Здесь есть два варианта, поэтому вы можете уточнить, что именно вы ищете.

1. Удалить конверт. Удаление конверта фактически не удаляет его из системы DocuSign, оно просто удаляет указатель пользователя на него, чтобы он больше не появлялся на вкладке «Управление». Чтобы удалить конверт, используйте метод Folders :: MoveEnvelopes с идентификатором папки «recyclebin». Обратите внимание, что если отправитель удалит конверт из процесса, он будет аннулирован.

   В этом примере показано, как удалить два конверта:

       FoldersApi foldersApi = new FoldersApi(apiClient.Configuration);
   
       FoldersRequest foldersRequest = new FoldersRequest();
       foldersRequest.EnvelopeIds = new List<string>();
       foldersRequest.EnvelopeIds.Add("000-111-222");
       foldersRequest.EnvelopeIds.Add("333-444-555");
   
       foldersApi.MoveEnvelopes(accountId, "recyclebin", foldersRequest);
   

2. Очистить конверт. Очищенные конверты полностью удалены из DocuSign, останется только запись-заглушка и Сертификат об окончании. Более подробная информация доступна здесь: https://support.docusign.com/en/guides/ndse-user-guide-purge-envelopes Обратите внимание, что при очистке конверта отправляются уведомления всем получателям с учетными записями DocuSign, и существует две недели задержки, чтобы позволить им получить доступ к конверту до его удаления.

   Чтобы поставить в очередь конверт для очистки, следует использовать метод Envelopes :: Update . При вызове этого метода через SDK рекомендуется создать пустой объект Envelope, установить там PurgeState, а затем применить этот объект с помощью метода Update ().

       EnvelopesApi envelopesApi = new EnvelopesApi(apiClient.Configuration);
       string envelopeId = "000-111-222";
   
       Envelope purgeEnvelope = new Envelope
       {
           PurgeState = "documents_queued" //change to "documents_and_metadata_queued" to also remove recipient info
       };
   
       envelopesApi.Update(accountId, envelopeId, purgeEnvelope);