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:
    1. archive - If the document to be downloaded in zip format.
    2. combined - If the document to be downloaded as a combined document.
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" } ]

Metadata

Release files for los-docusign 0.3.8

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for los-docusign 0.3.8
File	Size	Uploaded
los_docusign-0.3.8.tar.gz	18.2 kB	Feb 2, 2022	Details

Built distribution (wheel)

Table of built distributions (wheels) for los-docusign 0.3.8
File	Interpreter	ABI	Platform	Reset
los_docusign-0.3.8-py3-none-any.whl 24.6 kB Feb 2, 2022	Python 3	none	any	Details

Total release size: 42.8 kB

Release files / los_docusign-0.3.8.tar.gz

Download URL	los_docusign-0.3.8.tar.gz
Size	18.2 kB
Tags	Source
SHA-256 checksum How to use checksums	`9b098efbd676e8a802cd4348210a070863d4c6cab3ff0ca6eff6f8e2c709a2e6`
BLAKE2b-256 checksum How to use checksums	`359344fc0be7d926f92e1109dc9524671b47973daa54f9e4980154bc37c9386a`
Upload date	Feb 2, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.1.12 CPython/3.9.9 Windows/10`

Release files / los_docusign-0.3.8-py3-none-any.whl

Download URL	los_docusign-0.3.8-py3-none-any.whl
Size	24.6 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`1e5ced515791892af2294e534dc329fc019fb18e2f71c3ae094a81fa3ce84602`
BLAKE2b-256 checksum How to use checksums	`1c6fd2185f9a7229cb7556ef6711e88bc6601b637784a48c2b5c19d4fe52c2e2`
Upload date	Feb 2, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.1.12 CPython/3.9.9 Windows/10`