Version 8.0.0-rc1-v2.1-24.2.00.00 release (#224)

Co-authored-by: root <[email protected]>

.swagger-codegen-ignore

@@ -25,7 +25,6 @@
 .swagger-codegen-ignore
 git_push.sh
 .gitignore
-README.md
 CHANGELOG.md
 best_practices.md
 

CHANGELOG.md

@@ -3,6 +3,78 @@ 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.
 
+## [v8.0.0-rc1] - eSignature API v2.1-24.2.00.00 - 2024-07-02
+### Breaking Changes
+
+<details>
+<summary>API Changes (Click to expand)</summary>
+
+<div style="margin-left: 20px;">
+
+<br/>
+Added support for version v2.1-24.2.00.00 of the Docusign ESignature API.
+
+  ## Endpoint-Specific Changes
+
+  ### Updated [Envelopes: get](https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/get/)
+  Added new optional query parameter named `include_anchor_tab_locations` of type string.
+
+  ### Updated [Envelopes: update](https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/update/)
+  Added new optional query parameter named `recycle_on_void` of type string.
+
+  ### Updated [EnvelopeViews : createCorrect](https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeviews/createcorrect/)
+  Request body object `correctViewRequest` has been changed to `envelopeViewRequest`.
+
+  ## Model Changes
+
+  ### Updated existing models
+
+  ### `accountInformation`
+
+  - **Added fields:**
+    - `freeEnvelopeSendsRemainingForAdvancedDocGen`
+
+  ### `accountSettingsInformation`
+
+  - **Added fields:**
+    - `defaultSigningResponsiveView`
+    - `defaultSigningResponsiveViewMetadata`
+    - `dss_SCOREFDN_196_Rebrand_DocuSignIsNotAVerb`
+    - `enableAdditionalAdvancedWebFormsFeatures`
+    - `enableAdditionalAdvancedWebFormsFeaturesMetadata`
+
+- **Removed fields:**
+    - `enableSaveAsEnvelopeCustomFieldInWebForms`
+    - `enableSaveAsEnvelopeCustomFieldInWebFormsMetadata`
+
+### `bulksendingCopyDocGenFormField`
+
+- **Added field:**
+  - `rowValues`
+
+### `notaryRecipient`
+
+- **Added field:**
+  - `canNotaryCorrectEnvelope`
+
+### `tabAccountSettings`
+
+- **Added field:**
+  - `enableTabAgreementDetails`
+  - `enableTabAgreementDetailsMetadata`
+
+
+### Newly added Models
+
+- `bulkSendingCopyDocGenFormFieldRowValue`
+
+</div>
+</details>
+
+### Other Changes
+- Updated the SDK release version.
+
+
 ## [v7.0.0] - eSignature API v2.1-24.1.01.00 - 2024-05-22
 ## Endpoint-Specific Changes
 

README.md

@@ -1,62 +1,106 @@
-# The Official DocuSign eSignature PHP Client SDK
+# The Official Docusign eSignature PHP Client SDK
 
-[![Build status][travis-image]][travis-url]
+The Docusign SDK makes integrating Docusign into your apps and websites a seamless experience.
 
-## Requirements
-*   PHP 7.4+
-*   Free [developer account](https://go.docusign.com/sandbox/productshot/?elqCampaignId=16531)
+## Table of Contents
+- [Introduction](#introduction)
+- [Installation](#installation)
+	* [Version Information](#versionInformation)
+	* [Requirements](#requirements)
+	* [Compatibility](#compatibility)
+	* [Composer](#composer)
+	* [Manual Install](#manualInstall)
+- [Dependencies](#dependencies)
+- [API Reference](#apiReference)
+- [Code Examples](#codeExamples)
+- [OAuth Implementations](#oauthImplementations)
+- [Changelog](#changeLog)
+- [Support](#support)
+- [License](#license)
+- [Additional Resources](#additionalResources)
 
-## Compatibility
-*   PHP 7.4+
+<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 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.
+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.
+
+<a id="versionInformation"></a>
+### Version Information
+- **API version**: v2.1
+- **Latest SDK version**: 8.0.0-rc1
+
+<a id="requirements"></a>
+### Requirements
+*   PHP 7.4+
+*   Free [developer account](https://go.docusign.com/o/sandbox/?postActivateUrl=https://developers.docusign.com/)
 
+<a id="compatibility"></a>
+### Compatibility
+*   PHP 7.4+
+
+<a id="composer"></a>
 ### Composer:
 1. In your PHP console, type: **Composer require docusign/esign-client;**
 2. To use the package automatically, add to Composer's Autoload file: 
 `require_once('vendor/autoload.php');`
 
-### Manual install:
+<a id="manualInstall"></a>
+### Manual Install:
 
 <ol>
    <li>Download or clone this repository.</li>
    <li>Bind the PHP SDK to your server or place it in a static location.
        <ol style="list-style-type: lower-alpha simple">
            <li>To bind to your server, edit the <em>init.php</em> file. Add:<br>
-               <code>require_once('/path/to/docusign-esign-client/autoload.php');</code></li>
+               <code>require_once('/path/to/docusign-esign-php-client/autoload.php');</code></li>
            <li>To bind to single pages: In your PHP file that will utilize the PHP SDK, add:<br>
-                <code>require_once('/path/to/docusign-esign-client/autoload.php');</code></li>
+                <code>require_once('/path/to/docusign-esign-php-client/autoload.php');</code></li>
        </ol>
    </li>
    <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>
-      <code>"autoload": { "classmap": [ "/path/to/docusign-esign-client/src" ] }</code></li>
+      <code>"autoload": { "classmap": [ "/path/to/docusign-esign-php-client/src" ] }</code></li>
 </ol>
 
-## Dependencies
+<a id="dependencies"></a>
+## SDK Dependencies
 This client has the following external dependencies:
 *   [PHP cURL extension](https://www.php.net/manual/en/intro.curl.php)
 *   [PHP JSON extension](https://php.net/manual/en/book.json.php)
+*   [PHP MBString extension](https://www.php.net/manual/en/intro.mbstring.php)
+*   firebase/php-jwt v6.0
+
+<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 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.
+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.
 
+<a id="oauthImplementations"></a>
 ## 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/esign-rest-api/guides/authentication/oauth2-code-grant) flow.
+For security purposes, Docusign recommends using the [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode/) flow.
 
+<a id="changeLog"></a>
+## Changelog
+You can refer to the complete changelog [here](https://github.com/docusign/docusign-esign-php-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 PHP Client SDK is licensed under the [MIT License](https://github.com/docusign/docusign-php-client/blob/master/LICENSE).
+The Docusign eSignature PHP Client SDK is licensed under the [MIT License](https://github.com/docusign/docusign-esign-php-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-lX2NQ)
-
-[travis-image]: https://img.shields.io/travis/docusign/docusign-php-client.svg?style=flat
-[travis-url]: https://travis-ci.org/docusign/docusign-php-client
+*   [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-lX2NQ)

src/Api/AccountsApi.php

@@ -14,9 +14,9 @@
  */
 
 /**
- * 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.
+ * The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign.
  *
  * OpenAPI spec version: v2.1
  * Contact: [email protected]

src/Api/AuthenticationApi.php

@@ -14,9 +14,9 @@
  */
 
 /**
- * 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.
+ * The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign.
  *
  * OpenAPI spec version: v2.1
  * Contact: [email protected]

src/Api/BillingApi.php

@@ -14,9 +14,9 @@
  */
 
 /**
- * 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.
+ * The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign.
  *
  * OpenAPI spec version: v2.1
  * Contact: [email protected]

src/Api/BulkEnvelopesApi.php

@@ -14,9 +14,9 @@
  */
 
 /**
- * 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.
+ * The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign.
  *
  * OpenAPI spec version: v2.1
  * Contact: [email protected]

src/Api/BulkProcessDataApi.php

@@ -14,9 +14,9 @@
  */
 
 /**
- * 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.
+ * The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign.
  *
  * OpenAPI spec version: v2.1
  * Contact: [email protected]

src/Api/BulkProcessDataSendApi.php

@@ -14,9 +14,9 @@
  */
 
 /**
- * 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.
+ * The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign.
  *
  * OpenAPI spec version: v2.1
  * Contact: [email protected]

src/Api/CloudStorageApi.php

@@ -14,9 +14,9 @@
  */
 
 /**
- * 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.
+ * The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign.
  *
  * OpenAPI spec version: v2.1
  * Contact: [email protected]

src/Api/ConnectApi.php

@@ -14,9 +14,9 @@
  */
 
 /**
- * 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.
+ * The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign.
  *
  * OpenAPI spec version: v2.1
  * Contact: [email protected]

src/Api/CustomTabsApi.php

@@ -14,9 +14,9 @@
  */
 
 /**
- * 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.
+ * The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign.
  *
  * OpenAPI spec version: v2.1
  * Contact: [email protected]

src/Api/DiagnosticsApi.php

@@ -14,9 +14,9 @@
  */
 
 /**
- * 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.
+ * The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign.
  *
  * OpenAPI spec version: v2.1
  * Contact: [email protected]

src/Api/EmailArchiveApi.php

@@ -14,9 +14,9 @@
  */
 
 /**
- * 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.
+ * The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign.
  *
  * OpenAPI spec version: v2.1
  * Contact: [email protected]