# 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.
```python
INSTALLED_APPS = [
'los_docusign'
]
```
Test file has the sample implementation of the test_app
## Functions in client.py
1. generate_docusign_preview_url(dict)
Params required in dict:
- "envelope_id"
- "authentication_method"
- "email"
- "user_name"
- "client_user_id"
- "return_url"
2. create_envelope(payload)
Params required:
- DocuSign payload in JSON format
3. 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.
4. 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"
}
]
}
5. 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"
}
]
5. 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"
}
Raw data
{
"_id": null,
"home_page": "https://github.com/Lenders-Cooperative/Django-DocuSign",
"name": "los-docusign",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10.2,<4.0.0",
"maintainer_email": "",
"keywords": "",
"author": "tejasb",
"author_email": "tejas@thesummitgrp.com",
"download_url": "https://files.pythonhosted.org/packages/2a/76/159214b94244b01ede026fd8921df40349661fbc428b9d6283faa25946e8/los_docusign-0.6.6.tar.gz",
"platform": null,
"description": "# Django-DocuSign\nDjango wrapper app for DocuSign functionalities\n\n`pip install django-docusign`\n\n## Running Tests\nWe have a unit test defined for testing the los application.\nThis can be executed using the below command.\n\n```\npython manage.py test\n```\n\n## Usage\nIn order to use the system you must add los_docusign.apps.LosDocusignConfig to your installed apps in your settings.py file.\n```python\nINSTALLED_APPS = [\n 'los_docusign'\n]\n```\n\nTest file has the sample implementation of the test_app\n\n## Functions in client.py\n1. generate_docusign_preview_url(dict)\n\n Params required in dict:\n - \"envelope_id\"\n - \"authentication_method\"\n - \"email\"\n - \"user_name\"\n - \"client_user_id\"\n - \"return_url\"\n\n2. create_envelope(payload)\n\n Params required:\n - DocuSign payload in JSON format\n\n3. download_docusign_document(dict)\n\n Params required in dict:\n - \"envelope_id\"\n - \"doc_download_option\"\n - Valid Values:\n 1. archive - If the document to be downloaded in zip format.\n 2. combined - If the document to be downloaded as a combined document.\n\n4. process_docusign_webhook(xml_string)\n\n Params required:\n - Webhook XML string received from Docusign.\n\n Response dict:\n {\n \"envelopeId\": \"c57ec066-c5fa-4aa0-873d-6f285d70242a\",\n \"envelope_status\": \"sent\",\n \"recipients\": [\n {\n \"recipient_id\": \"a7f73f21-c4ff-4bcb-97c4-b03c91b8528a\",\n \"email\": \"test@test.com\",\n \"name\": \"John Nash\",\n \"status\": \"autoresponded\"\n },\n {\n \"recipient_id\": \"511b2ad3-6650-4773-a6b4-47f64a0ccdaf\",\n \"email\": \"jerry@test.com\",\n \"name\": \"Jerry Tunes\",\n \"status\": \"created\"\n },\n {\n \"recipient_id\": \"0851505f-5af2-42df-bce4-9e0ebe8bd2e2\",\n \"email\": \"tom@test.com\",\n \"name\": \"Tom Tunes\",\n \"status\": \"created\"\n }\n ]\n }\n\n5. update_envelope_and_resend(envelope_id, signers_data)\nThis function is used to update the email/phone number of the signer.\nThis is also used to resend the same envelope to the signers. For resending, recipientId and email are mandatory.\n\n Params required:\n - envelope_id - The envelope id for which we need to update the signers information or send the same envelope to the signers.\n - signers_data - The signer array which has the information about the signers that needs to be updated.\n Params required in signers_data:\n - email - The email of the signer.\n - recipientId - The recipient id of the signer\n - phone - The phone number of the signer (optional)\n\n signers_data example:\n [\n {\n \"recipientId\":\"123456\",\n \"email\":\"test@test.com\",\n \"phone\":\"1234567890\"\n }\n ]\n\n5. update_envelope_status(status_info):\nThis function is used to update the status of the envelope.\n\n Params required:\n - status_info - The dictionary variale which has the following parameters.\n - envelope_id - The envelope id for which the status needs to be updated\n - status - The status in which we need to set the envelope\n - reason - The reason (if applicable) to be set for the status change. This will be visible to the signer\n\n status_info example:\n {\n \"envelope_id\":\"b1435c5d-3d67-46e8-ab6a-54789f42924e\",\n \"status\":\"voided\",\n \"reason\":\"Voiding an envelope\"\n }\n \n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Docusign Django Wrapper for integrating DocuSign with Django Application",
"version": "0.6.6",
"project_urls": {
"Homepage": "https://github.com/Lenders-Cooperative/Django-DocuSign"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ee9b8ca61b0114306b5796e1343592b5fc3dac9e3bb3f352deb5f76d39aa3600",
"md5": "27eb9de1422e43a46704f57238d228f4",
"sha256": "ac1d0e8158447be7c14eaafe3ba4c8f7628e80e99baa0c1d4ebcfef2c5c1c86e"
},
"downloads": -1,
"filename": "los_docusign-0.6.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "27eb9de1422e43a46704f57238d228f4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10.2,<4.0.0",
"size": 34227,
"upload_time": "2023-05-05T22:52:48",
"upload_time_iso_8601": "2023-05-05T22:52:48.899887Z",
"url": "https://files.pythonhosted.org/packages/ee/9b/8ca61b0114306b5796e1343592b5fc3dac9e3bb3f352deb5f76d39aa3600/los_docusign-0.6.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2a76159214b94244b01ede026fd8921df40349661fbc428b9d6283faa25946e8",
"md5": "71f560d06152d71c2ac433ab1cb43407",
"sha256": "836425947527027a0f8ff16e4f083fb33288206c439c5cc54d400079d24b4448"
},
"downloads": -1,
"filename": "los_docusign-0.6.6.tar.gz",
"has_sig": false,
"md5_digest": "71f560d06152d71c2ac433ab1cb43407",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10.2,<4.0.0",
"size": 25815,
"upload_time": "2023-05-05T22:52:52",
"upload_time_iso_8601": "2023-05-05T22:52:52.683539Z",
"url": "https://files.pythonhosted.org/packages/2a/76/159214b94244b01ede026fd8921df40349661fbc428b9d6283faa25946e8/los_docusign-0.6.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-05 22:52:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Lenders-Cooperative",
"github_project": "Django-DocuSign",
"github_not_found": true,
"lcname": "los-docusign"
}
JSON
