Skip to content

Commit

Permalink
Version 5.0.0rc1-v2.1-24.2.00.00 release (#191)
Browse files Browse the repository at this point in the history
Co-authored-by: root <root@devcenteradmin.docusigntest.com>
  • Loading branch information
garg-mudit and root authored Jul 5, 2024
1 parent 3981733 commit 010d8d5
Show file tree
Hide file tree
Showing 538 changed files with 1,556 additions and 1,162 deletions.
3 changes: 1 addition & 2 deletions .swagger-codegen-ignore
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@
# Swagger and Git files
.swagger-codegen-ignore
git_push.sh
README.md
CHANGELOG.md

# Project files
Expand All @@ -33,4 +32,4 @@ setup.cfg

# Specific src and test files
docs/
test/
test/
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@ All notable changes to this project will be documented in this file.

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

## [v5.0.0rc1] - eSignature API v2.1-24.2.00.00 - 2024-06-28
### Changed
- Added support for version v2.1-24.2.00.00 of the DocuSign ESignature API.
- Updated the SDK release version.

## [v4.0.0] - eSignature API v2.1-24.1.01.00 - 2024-05-22
## Endpoint-Specific Changes

Expand Down
1 change: 1 addition & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
exclude test/*
90 changes: 65 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,56 @@
# The Official DocuSign eSignature Python Client SDK
# The Official Docusign eSignature Python Client SDK

[![PyPI version][pypi-image]][pypi-url]
<!--[![PyPI downloads][downloads-image]][downloads-url]-->
[![Build status][travis-image]][travis-url]

[PyPI module](https://pypi.python.org/pypi/docusign_esign)
The Docusign SDK makes integrating Docusign into your apps and websites a seamless experience.

## Table of Contents
- [Introduction](#introduction)
- [Installation](#installation)
* [Version Information](#versionInformation)
* [Requirements](#requirements)
* [Compatibility](#compatibility)
* [Path setup](#pathSetup)
* [Install via PIP](#pip)
- [Dependencies](#dependencies)
- [API Reference](#apiReference)
- [Code Examples](#codeExamples)
- [OAuth Implementations](#oauthImplementations)
- [Changelog](#changeLog)
- [Support](#support)
- [License](#license)
- [Additional Resources](#additionalResources)

<a id="introduction"></a>
## Introduction
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.

<a id="installation"></a>
## Installation
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.

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

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

<a id="compatibility"></a>
## Compatibility
* Python 2.7+

## Installation
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.

<a id="pathSetup"></a>
### Path setup:
1. Locate your Python installation, also referred to as a **site-packages** folder. This folder is usually labeled in a format of **Python{VersionNumber}**.
**Examples:**
* Unix/Linux: **/usr/lib/python2.7**
* Mac: **/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7**
* Windows: **C:\Users{username}\AppData\Local\Programs\Python\Python37**
* Windows: **C:\Users\{username}\AppData\Local\Programs\Python\Python37**
2. Add your Python folder’s path to your system as an environment variable.
**Unix/Linux:**
1. Type the following command into your console: \
Expand All @@ -43,45 +70,58 @@ This SDK is provided as open source, which enables you to customize its function
</li>
</ol>


**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.

<a id="pip"></a>
### Install via PIP:
In your command console, type: **pip install docusign-esign**
In your command console, type: **pip install docusign_esign**
**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.

## Dependencies
<a id="dependencies"></a>
## SDK Dependencies
This client has the following external dependencies:
* certifi v14.05.14+
* six v1.8.0+
* python_dateutil v2.5.3+
* setuptools v21.0.0+
* urllib3 v1.15.1+
* jwcrypto v0.4.2+
* py-oauth2 v0.0.10+
* PyJWT v2.0.0+
* cryptography v2.5+

<a id="apiReference"></a>
## API Reference
You can refer to the API reference [here](https://developers.docusign.com/docs/esign-rest-api/reference/).

<a id="codeExamples"></a>
## Code examples
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.
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.

## OAuth implementations
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/).
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/).

For security purposes, Docusign recommends using the [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode/) flow.

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

<a id="support"></a>
## Support
Log issues against this client through GitHub. We also have an [active developer community on Stack Overflow](https://stackoverflow.com/questions/tagged/docusignapi).
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).

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

<a id="additionalResources"></a>
### Additional resources
* [DocuSign Developer Center](https://developers.docusign.com/)
* [DocuSign API on Twitter](https://twitter.com/docusignapi)
* [DocuSign For Developers on LinkedIn](https://www.linkedin.com/showcase/docusign-for-developers/)
* [DocuSign For Developers on YouTube](https://www.youtube.com/channel/UCJSJ2kMs_qeQotmw4-lX2)
* [Docusign Developer Center](https://developers.docusign.com/)
* [Docusign API on Twitter](https://twitter.com/docusignapi)
* [Docusign For Developers on LinkedIn](https://www.linkedin.com/showcase/docusign-for-developers/)
* [Docusign For Developers on YouTube](https://www.youtube.com/channel/UCJSJ2kMs_qeQotmw4-lX2)

[pypi-image]: https://img.shields.io/pypi/v/docusign_esign.svg?style=flat
[pypi-url]: https://pypi.python.org/pypi/docusign_esign
[downloads-image]: https://img.shields.io/pypi/dm/docusign_esign.svg?style=flat
[downloads-url]: https://pypi.python.org/pypi/docusign_esign
[travis-image]: https://img.shields.io/travis/docusign/docusign-python-client.svg?style=flat
[travis-url]: https://travis-ci.org/docusign/docusign-python-client
[downloads-url]: https://pypi.python.org/pypi/docusign_esign
5 changes: 3 additions & 2 deletions docusign_esign/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
# flake8: noqa

"""
DocuSign REST API
Docusign eSignature REST API
The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501
The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501
OpenAPI spec version: v2.1
Contact: devcenter@docusign.com
Expand Down Expand Up @@ -152,6 +152,7 @@
from docusign_esign.models.bulk_send_test_response import BulkSendTestResponse
from docusign_esign.models.bulk_sending_copy import BulkSendingCopy
from docusign_esign.models.bulk_sending_copy_custom_field import BulkSendingCopyCustomField
from docusign_esign.models.bulk_sending_copy_doc_gen_form_field_row_value import BulkSendingCopyDocGenFormFieldRowValue
from docusign_esign.models.bulk_sending_copy_recipient import BulkSendingCopyRecipient
from docusign_esign.models.bulk_sending_copy_tab import BulkSendingCopyTab
from docusign_esign.models.bulk_sending_list import BulkSendingList
Expand Down
4 changes: 2 additions & 2 deletions docusign_esign/apis/accounts_api.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# coding: utf-8

"""
DocuSign REST API
Docusign eSignature REST API
The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501
The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501
OpenAPI spec version: v2.1
Contact: devcenter@docusign.com
Expand Down
4 changes: 2 additions & 2 deletions docusign_esign/apis/authentication_api.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# coding: utf-8

"""
DocuSign REST API
Docusign eSignature REST API
The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501
The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501
OpenAPI spec version: v2.1
Contact: devcenter@docusign.com
Expand Down
4 changes: 2 additions & 2 deletions docusign_esign/apis/billing_api.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# coding: utf-8

"""
DocuSign REST API
Docusign eSignature REST API
The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501
The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501
OpenAPI spec version: v2.1
Contact: devcenter@docusign.com
Expand Down
4 changes: 2 additions & 2 deletions docusign_esign/apis/bulk_envelopes_api.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# coding: utf-8

"""
DocuSign REST API
Docusign eSignature REST API
The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501
The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501
OpenAPI spec version: v2.1
Contact: devcenter@docusign.com
Expand Down
4 changes: 2 additions & 2 deletions docusign_esign/apis/bulk_process_data_api.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# coding: utf-8

"""
DocuSign REST API
Docusign eSignature REST API
The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501
The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501
OpenAPI spec version: v2.1
Contact: devcenter@docusign.com
Expand Down
4 changes: 2 additions & 2 deletions docusign_esign/apis/bulk_process_data_send_api.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# coding: utf-8

"""
DocuSign REST API
Docusign eSignature REST API
The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501
The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501
OpenAPI spec version: v2.1
Contact: devcenter@docusign.com
Expand Down
4 changes: 2 additions & 2 deletions docusign_esign/apis/cloud_storage_api.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# coding: utf-8

"""
DocuSign REST API
Docusign eSignature REST API
The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501
The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501
OpenAPI spec version: v2.1
Contact: devcenter@docusign.com
Expand Down
4 changes: 2 additions & 2 deletions docusign_esign/apis/connect_api.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# coding: utf-8

"""
DocuSign REST API
Docusign eSignature REST API
The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501
The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501
OpenAPI spec version: v2.1
Contact: devcenter@docusign.com
Expand Down
4 changes: 2 additions & 2 deletions docusign_esign/apis/custom_tabs_api.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# coding: utf-8

"""
DocuSign REST API
Docusign eSignature REST API
The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501
The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501
OpenAPI spec version: v2.1
Contact: devcenter@docusign.com
Expand Down
4 changes: 2 additions & 2 deletions docusign_esign/apis/diagnostics_api.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# coding: utf-8

"""
DocuSign REST API
Docusign eSignature REST API
The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501
The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501
OpenAPI spec version: v2.1
Contact: devcenter@docusign.com
Expand Down
4 changes: 2 additions & 2 deletions docusign_esign/apis/email_archive_api.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# coding: utf-8

"""
DocuSign REST API
Docusign eSignature REST API
The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501
The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501
OpenAPI spec version: v2.1
Contact: devcenter@docusign.com
Expand Down
Loading

0 comments on commit 010d8d5

Please sign in to comment.