Docusign Django Wrapper for integrating DocuSign with Django Application
Project description
Django-DocuSign
Django wrapper app for DocuSign functionalities
pip install django-docusign
Running Tests
We have a unit test defined for testing the los application. This can be executed using the below command.
python manage.py test
Usage
In order to use the system you must add los_docusign.apps.LosDocusignConfig to your installed apps in your settings.py file.
INSTALLED_APPS = [
'los_docusign'
]
Test file has the sample implementation of the test_app
Functions in client.py
-
generate_docusign_preview_url(dict)
Params required in dict:
- "envelope_id"
- "authentication_method"
- "email"
- "user_name"
- "client_user_id"
- "return_url"
-
create_envelope(payload)
Params required:
- DocuSign payload in JSON format
-
download_docusign_document(dict)
Params required in dict:
- "envelope_id"
- "doc_download_option"
- Valid Values:
- archive - If the document to be downloaded in zip format.
- combined - If the document to be downloaded as a combined document.
- Valid Values:
-
process_docusign_webhook(xml_string)
Params required:
- Webhook XML string received from Docusign.
Response dict: { "envelopeId": "c57ec066-c5fa-4aa0-873d-6f285d70242a", "envelope_status": "sent", "recipients": [ { "recipient_id": "a7f73f21-c4ff-4bcb-97c4-b03c91b8528a", "email": "test@test.com", "name": "John Nash", "status": "autoresponded" }, { "recipient_id": "511b2ad3-6650-4773-a6b4-47f64a0ccdaf", "email": "jerry@test.com", "name": "Jerry Tunes", "status": "created" }, { "recipient_id": "0851505f-5af2-42df-bce4-9e0ebe8bd2e2", "email": "tom@test.com", "name": "Tom Tunes", "status": "created" } ] }
-
update_envelope_and_resend(envelope_id, signers_data) This function is used to update the email/phone number of the signer. This is also used to resend the same envelope to the signers. For resending, recipientId and email are mandatory.
Params required:
- envelope_id - The envelope id for which we need to update the signers information or send the same envelope to the signers.
- signers_data - The signer array which has the information about the signers that needs to be updated. Params required in signers_data:
- email - The email of the signer.
- recipientId - The recipient id of the signer
- phone - The phone number of the signer (optional)
signers_data example: [ { "recipientId":"123456", "email":"test@test.com", "phone":"1234567890" } ]
-
update_envelope_status(status_info): This function is used to update the status of the envelope.
Params required:
- status_info - The dictionary variale which has the following parameters.
- envelope_id - The envelope id for which the status needs to be updated
- status - The status in which we need to set the envelope
- reason - The reason (if applicable) to be set for the status change. This will be visible to the signer
status_info example: { "envelope_id":"b1435c5d-3d67-46e8-ab6a-54789f42924e", "status":"voided", "reason":"Voiding an envelope" }
- status_info - The dictionary variale which has the following parameters.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file los_docusign-0.6.7.tar.gz
.
File metadata
- Download URL: los_docusign-0.6.7.tar.gz
- Upload date:
- Size: 26.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.4.2 CPython/3.11.3 Darwin/22.2.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 192964e3e976355a6e19ae60f4ccba3779145f4fb57830a02dce5328f27896ca |
|
MD5 | 4b388afb8af8b9e3b8cbaf8662a6ff7d |
|
BLAKE2b-256 | 62d5178bf56b3e065737fb43514423c2ce7cd889da834a621258473a42dc7670 |
File details
Details for the file los_docusign-0.6.7-py3-none-any.whl
.
File metadata
- Download URL: los_docusign-0.6.7-py3-none-any.whl
- Upload date:
- Size: 34.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.4.2 CPython/3.11.3 Darwin/22.2.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1c11bf6ac1889e237d74029597e11e53bf3fc2390e2bc4a4fca71e0e6270365c |
|
MD5 | 7beb777a1cd135423bdfb51a964c7140 |
|
BLAKE2b-256 | e1dce3205314738976b0eec25fa9fbdef683a807bb24b348a2046dc7c1929d67 |