Skip to content

Commit 0848f0e

Browse files
garg-muditroot
andauthored
Version 8.0.0-rc1-v2.1-24.2.00.00 release (#224)
Co-authored-by: root <[email protected]>
1 parent 69223c5 commit 0848f0e

File tree

529 files changed

+1866
-1145
lines changed

Some content is hidden

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

529 files changed

+1866
-1145
lines changed

.swagger-codegen-ignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@
2525
.swagger-codegen-ignore
2626
git_push.sh
2727
.gitignore
28-
README.md
2928
CHANGELOG.md
3029
best_practices.md
3130

CHANGELOG.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,78 @@ 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+
## [v8.0.0-rc1] - eSignature API v2.1-24.2.00.00 - 2024-07-02
7+
### Breaking Changes
8+
9+
<details>
10+
<summary>API Changes (Click to expand)</summary>
11+
12+
<div style="margin-left: 20px;">
13+
14+
<br/>
15+
Added support for version v2.1-24.2.00.00 of the Docusign ESignature API.
16+
17+
## Endpoint-Specific Changes
18+
19+
### Updated [Envelopes: get](https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/get/)
20+
Added new optional query parameter named `include_anchor_tab_locations` of type string.
21+
22+
### Updated [Envelopes: update](https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/update/)
23+
Added new optional query parameter named `recycle_on_void` of type string.
24+
25+
### Updated [EnvelopeViews : createCorrect](https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeviews/createcorrect/)
26+
Request body object `correctViewRequest` has been changed to `envelopeViewRequest`.
27+
28+
## Model Changes
29+
30+
### Updated existing models
31+
32+
### `accountInformation`
33+
34+
- **Added fields:**
35+
- `freeEnvelopeSendsRemainingForAdvancedDocGen`
36+
37+
### `accountSettingsInformation`
38+
39+
- **Added fields:**
40+
- `defaultSigningResponsiveView`
41+
- `defaultSigningResponsiveViewMetadata`
42+
- `dss_SCOREFDN_196_Rebrand_DocuSignIsNotAVerb`
43+
- `enableAdditionalAdvancedWebFormsFeatures`
44+
- `enableAdditionalAdvancedWebFormsFeaturesMetadata`
45+
46+
- **Removed fields:**
47+
- `enableSaveAsEnvelopeCustomFieldInWebForms`
48+
- `enableSaveAsEnvelopeCustomFieldInWebFormsMetadata`
49+
50+
### `bulksendingCopyDocGenFormField`
51+
52+
- **Added field:**
53+
- `rowValues`
54+
55+
### `notaryRecipient`
56+
57+
- **Added field:**
58+
- `canNotaryCorrectEnvelope`
59+
60+
### `tabAccountSettings`
61+
62+
- **Added field:**
63+
- `enableTabAgreementDetails`
64+
- `enableTabAgreementDetailsMetadata`
65+
66+
67+
### Newly added Models
68+
69+
- `bulkSendingCopyDocGenFormFieldRowValue`
70+
71+
</div>
72+
</details>
73+
74+
### Other Changes
75+
- Updated the SDK release version.
76+
77+
678
## [v7.0.0] - eSignature API v2.1-24.1.01.00 - 2024-05-22
779
## Endpoint-Specific Changes
880

README.md

Lines changed: 69 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,106 @@
1-
# The Official DocuSign eSignature PHP Client SDK
1+
# The Official Docusign eSignature PHP Client SDK
22

3-
[![Build status][travis-image]][travis-url]
3+
The Docusign SDK makes integrating Docusign into your apps and websites a seamless experience.
44

5-
## Requirements
6-
* PHP 7.4+
7-
* Free [developer account](https://go.docusign.com/sandbox/productshot/?elqCampaignId=16531)
5+
## Table of Contents
6+
- [Introduction](#introduction)
7+
- [Installation](#installation)
8+
* [Version Information](#versionInformation)
9+
* [Requirements](#requirements)
10+
* [Compatibility](#compatibility)
11+
* [Composer](#composer)
12+
* [Manual Install](#manualInstall)
13+
- [Dependencies](#dependencies)
14+
- [API Reference](#apiReference)
15+
- [Code Examples](#codeExamples)
16+
- [OAuth Implementations](#oauthImplementations)
17+
- [Changelog](#changeLog)
18+
- [Support](#support)
19+
- [License](#license)
20+
- [Additional Resources](#additionalResources)
821

9-
## Compatibility
10-
* PHP 7.4+
22+
<a id="introduction"></a>
23+
## Introduction
24+
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.
1125

26+
<a id="installation"></a>
1227
## Installation
13-
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.
28+
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.
29+
30+
<a id="versionInformation"></a>
31+
### Version Information
32+
- **API version**: v2.1
33+
- **Latest SDK version**: 8.0.0-rc1
34+
35+
<a id="requirements"></a>
36+
### Requirements
37+
* PHP 7.4+
38+
* Free [developer account](https://go.docusign.com/o/sandbox/?postActivateUrl=https://developers.docusign.com/)
1439

40+
<a id="compatibility"></a>
41+
### Compatibility
42+
* PHP 7.4+
43+
44+
<a id="composer"></a>
1545
### Composer:
1646
1. In your PHP console, type: **Composer require docusign/esign-client;**
1747
2. To use the package automatically, add to Composer's Autoload file:
1848
`require_once('vendor/autoload.php');`
1949

20-
### Manual install:
50+
<a id="manualInstall"></a>
51+
### Manual Install:
2152

2253
<ol>
2354
<li>Download or clone this repository.</li>
2455
<li>Bind the PHP SDK to your server or place it in a static location.
2556
<ol style="list-style-type: lower-alpha simple">
2657
<li>To bind to your server, edit the <em>init.php</em> file. Add:<br>
27-
<code>require_once('/path/to/docusign-esign-client/autoload.php');</code></li>
58+
<code>require_once('/path/to/docusign-esign-php-client/autoload.php');</code></li>
2859
<li>To bind to single pages: In your PHP file that will utilize the PHP SDK, add:<br>
29-
<code>require_once('/path/to/docusign-esign-client/autoload.php');</code></li>
60+
<code>require_once('/path/to/docusign-esign-php-client/autoload.php');</code></li>
3061
</ol>
3162
</li>
3263
<li>If you are using Composer V2 and get the error 'namespace cannot be found', add the following class mapping in the composer.json file.</li>
33-
<code>"autoload": { "classmap": [ "/path/to/docusign-esign-client/src" ] }</code></li>
64+
<code>"autoload": { "classmap": [ "/path/to/docusign-esign-php-client/src" ] }</code></li>
3465
</ol>
3566

36-
## Dependencies
67+
<a id="dependencies"></a>
68+
## SDK Dependencies
3769
This client has the following external dependencies:
3870
* [PHP cURL extension](https://www.php.net/manual/en/intro.curl.php)
3971
* [PHP JSON extension](https://php.net/manual/en/book.json.php)
72+
* [PHP MBString extension](https://www.php.net/manual/en/intro.mbstring.php)
73+
* firebase/php-jwt v6.0
74+
75+
<a id="apiReference"></a>
76+
## API Reference
77+
You can refer to the API reference [here](https://developers.docusign.com/docs/esign-rest-api/reference/).
4078

79+
<a id="codeExamples"></a>
4180
## Code examples
42-
You can find on our GitHub a self-executing package of code examples for the eSignature PHP SDK, called a [Launcher](https://github.com/docusign/code-examples-php/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.
81+
Explore our GitHub repository for the [Launcher](https://github.com/docusign/code-examples-php/), a self-executing package housing code examples for the eSignature PHP 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.
4382

83+
<a id="oauthImplementations"></a>
4484
## OAuth implementations
45-
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/).
85+
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/).
4686

47-
For security purposes, DocuSign recommends using the [Authorization Code Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant) flow.
87+
For security purposes, Docusign recommends using the [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode/) flow.
4888

89+
<a id="changeLog"></a>
90+
## Changelog
91+
You can refer to the complete changelog [here](https://github.com/docusign/docusign-esign-php-client/blob/master/CHANGELOG.md).
92+
93+
<a id="support"></a>
4994
## Support
50-
Log issues against this client through GitHub. We also have an [active developer community on Stack Overflow](https://stackoverflow.com/questions/tagged/docusignapi).
95+
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).
5196

97+
<a id="license"></a>
5298
## License
53-
The DocuSign eSignature PHP Client SDK is licensed under the [MIT License](https://github.com/docusign/docusign-php-client/blob/master/LICENSE).
99+
The Docusign eSignature PHP Client SDK is licensed under the [MIT License](https://github.com/docusign/docusign-esign-php-client/blob/master/LICENSE).
54100

101+
<a id="additionalResources"></a>
55102
### Additional resources
56-
* [DocuSign Developer Center](https://developers.docusign.com/)
57-
* [DocuSign API on Twitter](https://twitter.com/docusignapi)
58-
* [DocuSign For Developers on LinkedIn](https://www.linkedin.com/showcase/docusign-for-developers/)
59-
* [DocuSign For Developers on YouTube](https://www.youtube.com/channel/UCJSJ2kMs_qeQotmw4-lX2NQ)
60-
61-
[travis-image]: https://img.shields.io/travis/docusign/docusign-php-client.svg?style=flat
62-
[travis-url]: https://travis-ci.org/docusign/docusign-php-client
103+
* [Docusign Developer Center](https://developers.docusign.com/)
104+
* [Docusign API on Twitter](https://twitter.com/docusignapi)
105+
* [Docusign For Developers on LinkedIn](https://www.linkedin.com/showcase/docusign-for-developers/)
106+
* [Docusign For Developers on YouTube](https://www.youtube.com/channel/UCJSJ2kMs_qeQotmw4-lX2NQ)

src/Api/AccountsApi.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@
1414
*/
1515

1616
/**
17-
* DocuSign REST API
17+
* Docusign eSignature REST API
1818
*
19-
* The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
19+
* The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign.
2020
*
2121
* OpenAPI spec version: v2.1
2222
* Contact: [email protected]

src/Api/AuthenticationApi.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@
1414
*/
1515

1616
/**
17-
* DocuSign REST API
17+
* Docusign eSignature REST API
1818
*
19-
* The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
19+
* The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign.
2020
*
2121
* OpenAPI spec version: v2.1
2222
* Contact: [email protected]

src/Api/BillingApi.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@
1414
*/
1515

1616
/**
17-
* DocuSign REST API
17+
* Docusign eSignature REST API
1818
*
19-
* The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
19+
* The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign.
2020
*
2121
* OpenAPI spec version: v2.1
2222
* Contact: [email protected]

src/Api/BulkEnvelopesApi.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@
1414
*/
1515

1616
/**
17-
* DocuSign REST API
17+
* Docusign eSignature REST API
1818
*
19-
* The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
19+
* The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign.
2020
*
2121
* OpenAPI spec version: v2.1
2222
* Contact: [email protected]

src/Api/BulkProcessDataApi.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@
1414
*/
1515

1616
/**
17-
* DocuSign REST API
17+
* Docusign eSignature REST API
1818
*
19-
* The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
19+
* The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign.
2020
*
2121
* OpenAPI spec version: v2.1
2222
* Contact: [email protected]

src/Api/BulkProcessDataSendApi.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@
1414
*/
1515

1616
/**
17-
* DocuSign REST API
17+
* Docusign eSignature REST API
1818
*
19-
* The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
19+
* The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign.
2020
*
2121
* OpenAPI spec version: v2.1
2222
* Contact: [email protected]

src/Api/CloudStorageApi.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@
1414
*/
1515

1616
/**
17-
* DocuSign REST API
17+
* Docusign eSignature REST API
1818
*
19-
* The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
19+
* The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign.
2020
*
2121
* OpenAPI spec version: v2.1
2222
* Contact: [email protected]

0 commit comments

Comments
 (0)