Skip to content

Commit 010d8d5

Browse files
garg-muditroot
and
root
authored
Version 5.0.0rc1-v2.1-24.2.00.00 release (#191)
Co-authored-by: root <root@devcenteradmin.docusigntest.com>
1 parent 3981733 commit 010d8d5

File tree

538 files changed

+1556
-1162
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

538 files changed

+1556
-1162
lines changed

.swagger-codegen-ignore

+1-2
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@
2424
# Swagger and Git files
2525
.swagger-codegen-ignore
2626
git_push.sh
27-
README.md
2827
CHANGELOG.md
2928

3029
# Project files
@@ -33,4 +32,4 @@ setup.cfg
3332

3433
# Specific src and test files
3534
docs/
36-
test/
35+
test/

CHANGELOG.md

+5
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@ All notable changes to this project will be documented in this file.
33

44
See [DocuSign Support Center](https://support.docusign.com/en/releasenotes/) for Product Release Notes.
55

6+
## [v5.0.0rc1] - eSignature API v2.1-24.2.00.00 - 2024-06-28
7+
### Changed
8+
- Added support for version v2.1-24.2.00.00 of the DocuSign ESignature API.
9+
- Updated the SDK release version.
10+
611
## [v4.0.0] - eSignature API v2.1-24.1.01.00 - 2024-05-22
712
## Endpoint-Specific Changes
813

MANIFEST.in

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
exclude test/*

README.md

+65-25
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,56 @@
1-
# The Official DocuSign eSignature Python Client SDK
1+
# The Official Docusign eSignature Python Client SDK
22

33
[![PyPI version][pypi-image]][pypi-url]
44
<!--[![PyPI downloads][downloads-image]][downloads-url]-->
5-
[![Build status][travis-image]][travis-url]
65

7-
[PyPI module](https://pypi.python.org/pypi/docusign_esign)
6+
The Docusign SDK makes integrating Docusign into your apps and websites a seamless experience.
7+
8+
## Table of Contents
9+
- [Introduction](#introduction)
10+
- [Installation](#installation)
11+
* [Version Information](#versionInformation)
12+
* [Requirements](#requirements)
13+
* [Compatibility](#compatibility)
14+
* [Path setup](#pathSetup)
15+
* [Install via PIP](#pip)
16+
- [Dependencies](#dependencies)
17+
- [API Reference](#apiReference)
18+
- [Code Examples](#codeExamples)
19+
- [OAuth Implementations](#oauthImplementations)
20+
- [Changelog](#changeLog)
21+
- [Support](#support)
22+
- [License](#license)
23+
- [Additional Resources](#additionalResources)
24+
25+
<a id="introduction"></a>
26+
## Introduction
27+
Integrate eSignatures into your application in minutes. The secure and award-winning Docusign eSignature API makes requesting signatures, automating forms, and tracking documents directly from your app easy.
28+
29+
<a id="installation"></a>
30+
## Installation
31+
This client SDK is provided as open source, which enables you to customize its functionality to suit your particular use case. To do so, download or clone the repository. If the SDK’s given functionality meets your integration needs, or if you’re working through our [code examples](https://developers.docusign.com/docs/esign-rest-api/how-to/) from the [Docusign Developer Center](https://developers.docusign.com/), you merely need to install it by following the instructions below.
832

9-
[Documentation about DocuSign APIs](https://developers.docusign.com/)
33+
<a id="versionInformation"></a>
34+
### Version Information
35+
- **API version**: v2.1
36+
- **Latest SDK version**: 5.0.0rc1
1037

38+
<a id="requirements"></a>
1139
## Requirements
1240
* Python 2.7 (3.7+ recommended)
13-
* Free [developer account](https://go.docusign.com/sandbox/productshot/?elqCampaignId=16531)
41+
* Free [developer account](https://go.docusign.com/o/sandbox/?postActivateUrl=https://developers.docusign.com/)
1442

43+
<a id="compatibility"></a>
1544
## Compatibility
1645
* Python 2.7+
1746

18-
## Installation
19-
This SDK is provided as open source, which enables you to customize its functionality to suit your particular use case. To do so, download or clone the repository. If the SDK’s given functionality meets your integration needs, or if you’re working through our [code examples](https://developers.docusign.com/docs/esign-rest-api/how-to/) from the [DocuSign Developer Center](https://developers.docusign.com/), you merely need to install it by following the instructions below.
20-
47+
<a id="pathSetup"></a>
2148
### Path setup:
2249
1. Locate your Python installation, also referred to as a **site-packages** folder. This folder is usually labeled in a format of **Python{VersionNumber}**.
2350
**Examples:**
2451
* Unix/Linux: **/usr/lib/python2.7**
2552
* Mac: **/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7**
26-
* Windows: **C:\Users{username}\AppData\Local\Programs\Python\Python37**
53+
* Windows: **C:\Users\{username}\AppData\Local\Programs\Python\Python37**
2754
2. Add your Python folder’s path to your system as an environment variable.
2855
**Unix/Linux:**
2956
1. Type the following command into your console: \
@@ -43,45 +70,58 @@ This SDK is provided as open source, which enables you to customize its function
4370
</li>
4471
</ol>
4572

73+
4674
**Note:** If you are still unable to reference Python or pip via your command console, you can also add the path to the **site-packages** folder to the built-in environment variable labeled **Path**, which will take effect the next time you start your machine.
4775

76+
<a id="pip"></a>
4877
### Install via PIP:
49-
In your command console, type: **pip install docusign-esign**
78+
In your command console, type: **pip install docusign_esign**
5079
**Note:** This may require the command console to be elevated. You can accomplish this via sudo in Unix/Linux, or by running the command console as an administrator in Windows.
5180

52-
## Dependencies
81+
<a id="dependencies"></a>
82+
## SDK Dependencies
5383
This client has the following external dependencies:
5484
* certifi v14.05.14+
5585
* six v1.8.0+
5686
* python_dateutil v2.5.3+
5787
* setuptools v21.0.0+
5888
* urllib3 v1.15.1+
59-
* jwcrypto v0.4.2+
60-
* py-oauth2 v0.0.10+
89+
* PyJWT v2.0.0+
90+
* cryptography v2.5+
91+
92+
<a id="apiReference"></a>
93+
## API Reference
94+
You can refer to the API reference [here](https://developers.docusign.com/docs/esign-rest-api/reference/).
6195

96+
<a id="codeExamples"></a>
6297
## Code examples
63-
You can find on our GitHub a self-executing package of code examples for the eSignature Python SDK, called a [Launcher](https://github.com/docusign/code-examples-python/blob/master/README.md), that demonstrates common use cases. You can also download a version preconfigured for your DocuSign developer account from [Quickstart](https://developers.docusign.com/docs/esign-rest-api/quickstart/). These examples can use either the [Authorization Code Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant) or [JSON Web Token (JWT)](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-jsonwebtoken) authentication workflows.
98+
Explore our GitHub repository for the [Launcher](https://github.com/docusign/code-examples-python/), a self-executing package housing code examples for the eSignature Python SDK. This package showcases several common use cases and their respective source files. Additionally, you can download a version preconfigured for your Docusign developer account from [Quickstart](https://developers.docusign.com/docs/esign-rest-api/quickstart/). These examples support both the [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode/) and [JSON Web Token (JWT)](https://developers.docusign.com/platform/auth/jwt/) authentication workflows.
6499

65100
## OAuth implementations
66-
For details regarding which type of OAuth grant will work best for your DocuSign integration, see [Choose OAuth Type](https://developers.docusign.com/platform/auth/choose/) in the [DocuSign Developer Center](https://developers.docusign.com/).
101+
For details regarding which type of OAuth grant will work best for your Docusign integration, see [Choose OAuth Type](https://developers.docusign.com/platform/auth/choose/) in the [Docusign Developer Center](https://developers.docusign.com/).
102+
103+
For security purposes, Docusign recommends using the [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode/) flow.
67104

68-
For security purposes, DocuSign recommends using the [Authorization Code Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant) flow.
105+
<a id="changeLog"></a>
106+
## Changelog
107+
You can refer to the complete changelog [here](https://github.com/docusign/docusign-esign-python-client/blob/master/CHANGELOG.md).
69108

109+
<a id="support"></a>
70110
## Support
71-
Log issues against this client through GitHub. We also have an [active developer community on Stack Overflow](https://stackoverflow.com/questions/tagged/docusignapi).
111+
Log issues against this client SDK through GitHub. You can also reach out to us through [Docusign Community](https://community.docusign.com/developer-59) and [Stack Overflow](https://stackoverflow.com/questions/tagged/docusignapi).
72112

113+
<a id="license"></a>
73114
## License
74-
The DocuSign eSignature Python Client SDK is licensed under the [MIT License](https://github.com/docusign/docusign-python-client/blob/master/LICENSE).
115+
The Docusign eSignature Python Client SDK is licensed under the [MIT License](https://github.com/docusign/docusign-esign-python-client/blob/master/LICENSE).
75116

117+
<a id="additionalResources"></a>
76118
### Additional resources
77-
* [DocuSign Developer Center](https://developers.docusign.com/)
78-
* [DocuSign API on Twitter](https://twitter.com/docusignapi)
79-
* [DocuSign For Developers on LinkedIn](https://www.linkedin.com/showcase/docusign-for-developers/)
80-
* [DocuSign For Developers on YouTube](https://www.youtube.com/channel/UCJSJ2kMs_qeQotmw4-lX2)
119+
* [Docusign Developer Center](https://developers.docusign.com/)
120+
* [Docusign API on Twitter](https://twitter.com/docusignapi)
121+
* [Docusign For Developers on LinkedIn](https://www.linkedin.com/showcase/docusign-for-developers/)
122+
* [Docusign For Developers on YouTube](https://www.youtube.com/channel/UCJSJ2kMs_qeQotmw4-lX2)
81123

82124
[pypi-image]: https://img.shields.io/pypi/v/docusign_esign.svg?style=flat
83125
[pypi-url]: https://pypi.python.org/pypi/docusign_esign
84126
[downloads-image]: https://img.shields.io/pypi/dm/docusign_esign.svg?style=flat
85-
[downloads-url]: https://pypi.python.org/pypi/docusign_esign
86-
[travis-image]: https://img.shields.io/travis/docusign/docusign-python-client.svg?style=flat
87-
[travis-url]: https://travis-ci.org/docusign/docusign-python-client
127+
[downloads-url]: https://pypi.python.org/pypi/docusign_esign

docusign_esign/__init__.py

+3-2
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
# flake8: noqa
44

55
"""
6-
DocuSign REST API
6+
Docusign eSignature REST API
77
8-
The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501
8+
The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501
99
1010
OpenAPI spec version: v2.1
1111
Contact: devcenter@docusign.com
@@ -152,6 +152,7 @@
152152
from docusign_esign.models.bulk_send_test_response import BulkSendTestResponse
153153
from docusign_esign.models.bulk_sending_copy import BulkSendingCopy
154154
from docusign_esign.models.bulk_sending_copy_custom_field import BulkSendingCopyCustomField
155+
from docusign_esign.models.bulk_sending_copy_doc_gen_form_field_row_value import BulkSendingCopyDocGenFormFieldRowValue
155156
from docusign_esign.models.bulk_sending_copy_recipient import BulkSendingCopyRecipient
156157
from docusign_esign.models.bulk_sending_copy_tab import BulkSendingCopyTab
157158
from docusign_esign.models.bulk_sending_list import BulkSendingList

docusign_esign/apis/accounts_api.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# coding: utf-8
22

33
"""
4-
DocuSign REST API
4+
Docusign eSignature REST API
55
6-
The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501
6+
The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501
77
88
OpenAPI spec version: v2.1
99
Contact: devcenter@docusign.com

docusign_esign/apis/authentication_api.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# coding: utf-8
22

33
"""
4-
DocuSign REST API
4+
Docusign eSignature REST API
55
6-
The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501
6+
The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501
77
88
OpenAPI spec version: v2.1
99
Contact: devcenter@docusign.com

docusign_esign/apis/billing_api.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# coding: utf-8
22

33
"""
4-
DocuSign REST API
4+
Docusign eSignature REST API
55
6-
The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501
6+
The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501
77
88
OpenAPI spec version: v2.1
99
Contact: devcenter@docusign.com

docusign_esign/apis/bulk_envelopes_api.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# coding: utf-8
22

33
"""
4-
DocuSign REST API
4+
Docusign eSignature REST API
55
6-
The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501
6+
The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501
77
88
OpenAPI spec version: v2.1
99
Contact: devcenter@docusign.com

docusign_esign/apis/bulk_process_data_api.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# coding: utf-8
22

33
"""
4-
DocuSign REST API
4+
Docusign eSignature REST API
55
6-
The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501
6+
The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501
77
88
OpenAPI spec version: v2.1
99
Contact: devcenter@docusign.com

docusign_esign/apis/bulk_process_data_send_api.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# coding: utf-8
22

33
"""
4-
DocuSign REST API
4+
Docusign eSignature REST API
55
6-
The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501
6+
The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501
77
88
OpenAPI spec version: v2.1
99
Contact: devcenter@docusign.com

docusign_esign/apis/cloud_storage_api.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# coding: utf-8
22

33
"""
4-
DocuSign REST API
4+
Docusign eSignature REST API
55
6-
The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501
6+
The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501
77
88
OpenAPI spec version: v2.1
99
Contact: devcenter@docusign.com

docusign_esign/apis/connect_api.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# coding: utf-8
22

33
"""
4-
DocuSign REST API
4+
Docusign eSignature REST API
55
6-
The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501
6+
The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501
77
88
OpenAPI spec version: v2.1
99
Contact: devcenter@docusign.com

docusign_esign/apis/custom_tabs_api.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# coding: utf-8
22

33
"""
4-
DocuSign REST API
4+
Docusign eSignature REST API
55
6-
The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501
6+
The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501
77
88
OpenAPI spec version: v2.1
99
Contact: devcenter@docusign.com

docusign_esign/apis/diagnostics_api.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# coding: utf-8
22

33
"""
4-
DocuSign REST API
4+
Docusign eSignature REST API
55
6-
The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501
6+
The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501
77
88
OpenAPI spec version: v2.1
99
Contact: devcenter@docusign.com

docusign_esign/apis/email_archive_api.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# coding: utf-8
22

33
"""
4-
DocuSign REST API
4+
Docusign eSignature REST API
55
6-
The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501
6+
The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501
77
88
OpenAPI spec version: v2.1
99
Contact: devcenter@docusign.com

0 commit comments

Comments
 (0)