Skip to content

Commit 8bc36ee

Browse files
Version 2.9.0rc1 release (#105)
* Version 2.9.0rc1-v2-21.1.01 release * Update __init__.py * Update __init__.py Co-authored-by: DevCenter-DocuSign <dcdev@docusign.com>
1 parent 4b9ad89 commit 8bc36ee

File tree

13 files changed

+748
-209
lines changed

13 files changed

+748
-209
lines changed

CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,14 @@ 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+
## [2.8.1] - eSignature API v2-20.4.01 - 2021-02-26
7+
### Changed
8+
- Added support for version v2-20.4.01 of the DocuSign eSignature API.
9+
- Updated the SDK release version.
10+
### Fixed
11+
- Exposed BulkEnvelopeApi and other api files as public and accessible.
12+
- Adding `Type` fix in envelope_document model.
13+
614
## [2.7.0] - eSignature API v2-20.3.00 - 2020-09-24
715
### Changed
816
* Added support for version v2-20.3.00 of the DocuSign eSignature API.

README.md

Lines changed: 42 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# The Official DocuSign Python Client
1+
# The Official DocuSign eSignature Python Client SDK
22

33
[![PyPI version][pypi-image]][pypi-url]
44
<!--[![PyPI downloads][downloads-image]][downloads-url]-->
@@ -17,55 +17,41 @@
1717

1818
- Python 2.7+
1919

20-
## Note
21-
22-
This open-source SDK is provided for cases where you would like to make additional changes that the SDK does not provide out-of-the-box. If you simply want to use the SDK with any of the examples shown in the [Developer Center](https://developers.docusign.com/esign-rest-api/code-examples), follow the installation instructions below.
23-
2420
## Installation
25-
26-
### Path Setup:
27-
28-
1. Locate your Python installation, also referred to as a **site-packages** folder. This folder is usually labeled in a format of Python{VersionNumber}.
29-
30-
**Examples:**
31-
32-
- **Unix/Linux:** /usr/lib/python2.7
33-
- **Mac:** /Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7
34-
- **Windows:** C:\Users\{username}\AppData\Local\Programs\Python\Python37
35-
36-
1. Add the path to your Python folder as an environment variable.
37-
38-
**Unix/Linux:**
39-
40-
- Type the following command into your console:
41-
**export PYTHONPATH = "${PYTHONPATH}:.:/path/to/site-packages"**
42-
- Optionally, you can add this command to your system profile, which will run the command each time Python is launched.
43-
44-
**Windows:**
45-
46-
<ol>
47-
<li>Open the Windows <b>Control Panel.</b></li>
48-
<li>Under the System and Security category, open the <b>System</b></li>
49-
<li>Select <b>Advanced System Settings</b> to open the <b>System Properties</b> dialog box.</li>
50-
<li>On the <b>Advanced</b> tab, select the <b>Environmental Variables</b> button at the lower-right corner.
51-
<ol style="list-style-type: lower-alpha">
52-
<li>Check if <b>PYTHONPATH</b> has been added as a <b>system variable.</b></li>
53-
<li>If it has not, select <b>New</b> to add it. The variable you add is the path to the <b>site-packages</b></li>
54-
</ol>
55-
</li>
56-
</ol>
57-
58-
**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.
21+
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.
22+
23+
### Path setup:
24+
1. Locate your Python installation, also referred to as a **site-packages** folder. This folder is usually labeled in a format of **Python{VersionNumber}**.
25+
**Examples:**
26+
* Unix/Linux: **/usr/lib/python2.7**
27+
* Mac: **/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7**
28+
* Windows: **C:\Users{username}\AppData\Local\Programs\Python\Python37**
29+
2. Add your Python folder’s path to your system as an environment variable.
30+
**Unix/Linux:**
31+
1. Type the following command into your console: \
32+
**export PYTHONPATH = "${PYTHONPATH}:.:/_path_/_to_/_site-packages_"**
33+
2. Optionally, you can add this command to your system profile, which will run the command each time Python is launched.
34+
35+
**Windows:**
36+
<ol>
37+
<li>Open the Windows <strong>Control Panel.</strong></li>
38+
<li>Under the System and Security category, open the <strong>System</strong> information panel.</li>
39+
<li>Select <strong>Advanced System Settings</strong> to open the <strong>System Properties</strong> dialog box.</li>
40+
<li>On the <strong>Advanced</strong> tab, select the <strong>Environment Variables</strong> button at the lower-right corner.
41+
<ol style="list-style-type: lower-alpha">
42+
<li>Check to see whether <strong>PYTHONPATH</strong> has been added as a <strong>system variable.</strong></li>
43+
<li>If it has not, select <strong>New</strong> to add it. The variable you add is the path to the <strong>site-packages</strong> folder.</li>
44+
</ol>
45+
</li>
46+
</ol>
47+
48+
**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.
5949

6050
### Install via PIP:
61-
62-
1. In your command console, type:
63-
pip install docusign-esign
64-
65-
Note: This may require the command console be elevated. You can accomplish this via sudoin Unix/Linux, or by running the command console as an administrator in Windows.
51+
In your command console, type: **pip install docusign-esign**
52+
**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.
6653

6754
## Dependencies
68-
6955
This client has the following external dependencies:
7056

7157
- certifi v14.05.14+
@@ -76,41 +62,29 @@ This client has the following external dependencies:
7662
- jwcrypto v0.4.2+
7763
- py-oauth2 v0.0.10+
7864

79-
## Code Examples
80-
81-
### Launchers
82-
83-
DocuSign provides a sample application code referred to as a [Launcher](https://github.com/docusign/code-examples-python). The Launcher contains a set of 31 common use cases and associated source files. These examples use either DocuSign&#39;s [Authorization Code Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant) or [JSON Web Tokens (JWT)](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-jsonwebtoken) flows.
84-
85-
## Proof-of-concept applications
65+
## Code examples
66+
You can find on our GitHub a self-executing package of code examples for the eSignature C# 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.
8667

87-
If your goal is to create a proof of concept application, DocuSign provides a set of [Quick Start](https://github.com/docusign/qs-python) examples. The Quick Start examples are meant to be used with DocuSign&#39;s [OAuth Token Generator](https://developers.docusign.com/oauth-token-generator), which will allow you to generate tokens for the Demo/Sandbox environment only. These tokens last for eight hours and will enable you to build your proof-of-concept application without the need to fully implement an OAuth solution.
88-
89-
## OAuth Implementations
90-
91-
For details regarding which type of OAuth grant will work best for your DocuSign integration, see the [REST API Authentication Overview](https://developers.docusign.com/esign-rest-api/guides/authentication) guide located on the [DocuSign Developer Center](https://developers.docusign.com/esign-rest-api/guides/authentication).
68+
## OAuth implementations
69+
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/).
9270

9371
For security purposes, DocuSign recommends using the [Authorization Code Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant) flow.
9472

95-
9673
## Support
97-
9874
Log issues against this client through GitHub. We also have an [active developer community on Stack Overflow](https://stackoverflow.com/questions/tagged/docusignapi).
9975

10076
## License
77+
The DocuSign eSignature Python Client SDK is licensed under the [MIT License](https://github.com/docusign/docusign-python-client/blob/master/LICENSE).
10178

102-
The DocuSign Python Client is licensed under the [MIT License](https://github.com/docusign/docusign-python-client/blob/master/LICENSE).
103-
79+
### Additional resources
80+
* [DocuSign Developer Center](https://developers.docusign.com/)
81+
* [DocuSign API on Twitter](https://twitter.com/docusignapi)
82+
* [DocuSign For Developers on LinkedIn](https://www.linkedin.com/showcase/docusign-for-developers/)
83+
* [DocuSign For Developers on YouTube](https://www.youtube.com/channel/UCJSJ2kMs_qeQotmw4-lX2
10484

10585
[pypi-image]: https://img.shields.io/pypi/v/docusign_esign.svg?style=flat
10686
[pypi-url]: https://pypi.python.org/pypi/docusign_esign
10787
[downloads-image]: https://img.shields.io/pypi/dm/docusign_esign.svg?style=flat
10888
[downloads-url]: https://pypi.python.org/pypi/docusign_esign
10989
[travis-image]: https://img.shields.io/travis/docusign/docusign-python-client.svg?style=flat
110-
[travis-url]: https://travis-ci.org/docusign/docusign-python-client
111-
112-
### Additional Resources
113-
* [DocuSign Developer Center](https://developers.docusign.com)
114-
* [DocuSign API on Twitter](https://twitter.com/docusignapi)
115-
* [DocuSign For Developers on LinkedIn](https://www.linkedin.com/showcase/docusign-for-developers/)
116-
* [DocuSign For Developers on YouTube](https://www.youtube.com/channel/UCJSJ2kMs_qeQotmw4-lX2NQ)
90+
[travis-url]: https://travis-ci.org/docusign/docusign-python-client

docusign_esign/__init__.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,11 @@
2929
from .apis.notary_api import NotaryApi
3030
from .apis.organizations_api import OrganizationsApi
3131
from .apis.power_forms_api import PowerFormsApi
32+
from .apis.signature_api import SignatureApi
3233
from .apis.signing_groups_api import SigningGroupsApi
3334
from .apis.templates_api import TemplatesApi
34-
from .apis.trust_service_providers_api import TrustServiceProvidersApi
3535
from .apis.users_api import UsersApi
3636
from .apis.workspaces_api import WorkspacesApi
37-
from .apis.bulk_envelopes_api import BulkEnvelopesApi
3837

3938
# import models into sdk package
4039
from docusign_esign.models.account_address import AccountAddress

docusign_esign/apis/__init__.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,8 @@
1616
from .notary_api import NotaryApi
1717
from .organizations_api import OrganizationsApi
1818
from .power_forms_api import PowerFormsApi
19+
from .signature_api import SignatureApi
1920
from .signing_groups_api import SigningGroupsApi
2021
from .templates_api import TemplatesApi
21-
from .trust_service_providers_api import TrustServiceProvidersApi
2222
from .users_api import UsersApi
2323
from .workspaces_api import WorkspacesApi
24-
from .bulk_envelopes_api import BulkEnvelopesApi

docusign_esign/apis/accounts_api.py

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3255,6 +3255,107 @@ def get_provisioning_with_http_info(self, **kwargs):
32553255
_request_timeout=params.get('_request_timeout'),
32563256
collection_formats=collection_formats)
32573257

3258+
def get_seal_providers(self, account_id, **kwargs):
3259+
"""
3260+
Returns Account available seals for specified account.
3261+
This method makes a synchronous HTTP request by default. To make an
3262+
asynchronous HTTP request, please define a `callback` function
3263+
to be invoked when receiving the response.
3264+
>>> def callback_function(response):
3265+
>>> pprint(response)
3266+
>>>
3267+
>>> thread = api.get_seal_providers(account_id, callback=callback_function)
3268+
3269+
:param callback function: The callback function
3270+
for asynchronous request. (optional)
3271+
:param str account_id: The external account number (int) or account ID Guid. (required)
3272+
:return: AccountSeals
3273+
If the method is called asynchronously,
3274+
returns the request thread.
3275+
"""
3276+
kwargs['_return_http_data_only'] = True
3277+
if kwargs.get('callback'):
3278+
return self.get_seal_providers_with_http_info(account_id, **kwargs)
3279+
else:
3280+
(data) = self.get_seal_providers_with_http_info(account_id, **kwargs)
3281+
return data
3282+
3283+
def get_seal_providers_with_http_info(self, account_id, **kwargs):
3284+
"""
3285+
Returns Account available seals for specified account.
3286+
This method makes a synchronous HTTP request by default. To make an
3287+
asynchronous HTTP request, please define a `callback` function
3288+
to be invoked when receiving the response.
3289+
>>> def callback_function(response):
3290+
>>> pprint(response)
3291+
>>>
3292+
>>> thread = api.get_seal_providers_with_http_info(account_id, callback=callback_function)
3293+
3294+
:param callback function: The callback function
3295+
for asynchronous request. (optional)
3296+
:param str account_id: The external account number (int) or account ID Guid. (required)
3297+
:return: AccountSeals
3298+
If the method is called asynchronously,
3299+
returns the request thread.
3300+
"""
3301+
3302+
all_params = ['account_id']
3303+
all_params.append('callback')
3304+
all_params.append('_return_http_data_only')
3305+
all_params.append('_preload_content')
3306+
all_params.append('_request_timeout')
3307+
3308+
params = locals()
3309+
for key, val in iteritems(params['kwargs']):
3310+
if key not in all_params:
3311+
raise TypeError(
3312+
"Got an unexpected keyword argument '%s'"
3313+
" to method get_seal_providers" % key
3314+
)
3315+
params[key] = val
3316+
del params['kwargs']
3317+
# verify the required parameter 'account_id' is set
3318+
if ('account_id' not in params) or (params['account_id'] is None):
3319+
raise ValueError("Missing the required parameter `account_id` when calling `get_seal_providers`")
3320+
3321+
3322+
collection_formats = {}
3323+
3324+
resource_path = '/v2/accounts/{accountId}/seals'.replace('{format}', 'json')
3325+
path_params = {}
3326+
if 'account_id' in params:
3327+
path_params['accountId'] = params['account_id']
3328+
3329+
query_params = {}
3330+
3331+
header_params = {}
3332+
3333+
form_params = []
3334+
local_var_files = {}
3335+
3336+
body_params = None
3337+
# HTTP header `Accept`
3338+
header_params['Accept'] = self.api_client.\
3339+
select_header_accept(['application/json'])
3340+
3341+
# Authentication setting
3342+
auth_settings = []
3343+
3344+
return self.api_client.call_api(resource_path, 'GET',
3345+
path_params,
3346+
query_params,
3347+
header_params,
3348+
body=body_params,
3349+
post_params=form_params,
3350+
files=local_var_files,
3351+
response_type='AccountSeals',
3352+
auth_settings=auth_settings,
3353+
callback=params.get('callback'),
3354+
_return_http_data_only=params.get('_return_http_data_only'),
3355+
_preload_content=params.get('_preload_content', True),
3356+
_request_timeout=params.get('_request_timeout'),
3357+
collection_formats=collection_formats)
3358+
32583359
def get_supported_languages(self, account_id, **kwargs):
32593360
"""
32603361
Gets list of supported languages for recipient language setting.

0 commit comments

Comments
 (0)