# DocuSign PHP Client Change Log
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] - eSignature API v2.1-24.2.00.00 - 2024-07-23
### 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.


## [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

### Updated [EnvelopeRecipients: createRecipientProofFileResourceToken](https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipients/createrecipientprooffileresourcetoken/)
The `"token_scopes"` parameter has been moved from path parameters to query parameters for the above mentioned endpoint.

### Updated [EnvelopeView:CreateSender](https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeviews/createsender/) and [EnvelopeView:CreateEdit](https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeviews/createedit/)
The body parameter `returnUrlRequest` has been changed to `envelopeViewRequest`.
`envelopeViewRequest` has the same properties as the previous `returnUrlRequest` but now includes additional `viewAccess` and `settings` properties, where settings is a complex object with several UI controls for the view experience.

### Updated [TemplateViews: createEdit](https://developers.docusign.com/docs/esign-rest-api/reference/templates/templateviews/createedit/)
The body parameter `returnUrlRequest` has been changed to `templateViewRequest`.
`templateViewRequest` has the same properties as the previous `returnUrlRequest` but now includes an additional `viewAccess` string.

## Model Changes

- Updated existing models

### `accountSettingsInformation`

- **Added fields:**
  - `allowConnectEnvelopeRemovedEvent`
  - `allowOrganizationBranding`
  - `allowOrganizationBrandingMetadata`
  - `allowPendingDestinationUrlEdition`
  - `allowPendingDestinationUrlEditionMetadata`
  - `disableBulkSendRecipientLimit`
  - `disableBulkSendRecipientLimitMetaData`
  - `enableAdvancedSearch`
  - `enableAdvancedSearchMetadata`
  - `enableContentSearch`
  - `enableContentSearchMetadata`
  - `enableMultiUserRepositoryFeatures`
  - `enableMultiUserRepositoryFeaturesMetadata`
  - `enablePremiumDataVerificationExtensions`
  - `enablePremiumDataVerificationExtensionsMetadata`
  - `enableSaveAsEnvelopeCustomFieldInWebForms`
  - `enableSaveAsEnvelopeCustomFieldInWebFormsMetadata`
  - `enableScheduledRelease`
  - `enableScheduledReleaseMetadata`
  - `isvOemEmbed`
  - `isvOemEmbedMetaData`

- **Removed fields:**
  - `enableInboxRelevanceSortForRecentAccounts`
  - `enableInboxRelevanceSortForRecentAccountsMetadata`
  - `enableScheduledRelease`
  - `enableScheduledReleaseMetadata`
  - `enableSearch`
  - `enableSearchMetadata`
  - `enableSearchUI`
  - `enableSearchUIMetadata`

### `accountUISettings`

- **Added fields:**
  - `enableEnvelopeTypes`
  - `enableEnvelopeTypesMetadata`

### `envelopDefinitions`

- **Added field:**
  - `uSigState`

### `envelopTemplate`

- **Added field:**
  - `uSigState`

### `group`

- **Added property:**
  - `lastModifiedOn`

### `receipientViewRequest`

- **Added property:**
  - `displayFormat`

### `userSettingsInformation`

- **Added properties:**
  - `accountAgreementsAccessType`
  - `accountAgreementsAccessTypeMetadata`
  - `canBulkUploadAgreements`
  - `canBulkUploadAgreementsMetadata`
  - `canManageAgreementParties`
  - `canManageAgreementPartiesMetadata`

### Newly added Models

- `envelopeViewDocumentSettings`
- `envelopeViewEnvelopeCustomFieldSettings`
- `envelopeViewRecipientSettings`
- `envelopeViewRequest`
- `envelopeViewSettings`
- `envelopeViewTaggerSettings`
- `envelopeViewTemplateSettings`
- `paletteItemSettings`
- `paletteSettings`
- `templateViewRequest`

### Removed Models
- `returnUrlRequest`

## [v7.0.0-rc1] - eSignature API v2.1-24.1.01.00 - 2024-05-02
### Changed
- Added support for version v2.1-24.1.01.00 of the DocuSign ESignature API.
- Updated the SDK release version.

## [v6.19.0] - eSignature API v2.1-23.4.02.00 - 2024-04-30
### Changed
- Added support for version v2.1-23.4.02.00 of the DocuSign ESignature API.
- Updated the SDK release version.
- Adjusted the minimum required firebase/php-jwt package version to 6.0.

## [v6.19.0-rc2] - eSignature API v2.1-23.4.02.00 - 2024-03-15
### Changed
- Added support for version v2.1-23.4.02.00 of the DocuSign ESignature API.
- Updated the SDK release version.
- Adjusted the minimum required firebase/php-jwt package version to 6.0.


## [v6.19.0-rc1] - eSignature API v2.1-23.4.02.00 - 2024-03-12
### Changed
- Added support for version v2.1-23.4.02.00 of the DocuSign ESignature API.
- Updated the SDK release version.

## [v6.19.0-alpha1] - eSignature API v2.1-23.4.02.00 - 2024-03-07
### Changed
- Added support for version v2.1-23.4.02.00 of the DocuSign ESignature API.
- Updated the SDK release version.

## [v6.18.0] - eSignature API v2.1-23.3.01.02 - 2023-11-13
### Changed
- Added support for version v2.1-23.3.01.02 of the DocuSign ESignature API.
- Updated the SDK release version.

## [v6.18.0-rc] - eSignature API v2.1-23.3.01.02 - 2023-10-25
### Changed
- Added support for version v2.1-23.3.01.02 of the DocuSign ESignature API.
- Updated the SDK release version.

## [v6.17.0] - eSignature API v2.1-23.3.00.01 - 2023-09-01
### Changed
- Added support for version v2.1-23.3.00.01 of the DocuSign ESignature API.
- Updated the SDK release version.

## [v6.17.0-rc] - eSignature API v2.1-23.3.00.01 - 2023-08-30
### Changed
- Added support for version v2.1-23.3.00.01 of the DocuSign ESignature API.
- Updated the SDK release version.

## [v6.16.0] - eSignature API v2.1-23.2.00.00 - 2023-06-27
### Changed
- Added support for version v2.1-23.2.00.00 of the DocuSign ESignature API.
- Updated the SDK release version.

## [v6.16.0-rc] - eSignature API v2.1-23.2.00.00 - 2023-05-15
### Changed
- Added support for version v2.1-23.2.00.00 of the DocuSign ESignature API.
- Updated the SDK release version.

## [v6.15.0-rc] - eSignature API v2.1-23.1.01.01 - 2023-04-05
### Changed
- Added support for version v2.1-23.1.01.01 of the DocuSign ESignature API.
- Updated the SDK release version.

## [v6.14.0-rc] - eSignature API v2.1-23.1.01.00 - 2023-03-17
### Changed
- Added support for version v2.1-23.1.01.00 of the DocuSign ESignature API.
- Updated the SDK release version.

## [v6.13.0-rc] - eSignature API v2.1-22.4.02.00 - 2023-02-10
### Changed
- Added support for version v2.1-22.4.02.00 of the DocuSign ESignature API.
- Updated the SDK release version.

## [v6.13.0] - eSignature API v2.1-22.4.00.00 - 2022-12-30
### Changed
- Added support for version v2.1-22.4.00.00 of the DocuSign ESignature API.
- Updated the SDK release version.

## [v6.12.0] - eSignature API v2.1-22.3.01.00 - 2022-11-18
### Changed
- Added support for version v2.1-22.3.01.00 of the DocuSign ESignature API.
- Updated the SDK release version.

## [v6.12.0-rc] - eSignature API v2.1-22.3.00.00 - 2022-11-08
### Fixed
- Issue - [`#172`](https://github.com/docusign/docusign-esign-php-client/issues/172):  Cannot install the last version due to the firebase/php-jwt version.
- Issue - [`#174`](https://github.com/docusign/docusign-esign-php-client/issues/174):  Consider making firebase/php-jwt version requirement more relaxed.

## [v6.11.0] - eSignature API v2.1-22.3.00.00 - 2022-08-30
### Changed
- Added support for version v2.1-1.2.7 of the DocuSign DBTest API.
- Updated the SDK release version.

## [v6.10.0] - eSignature API v2.1-22.2.00.00 - 2022-06-17
### Changed
- Added support for version v2.1-22.2.00.00 of the DocuSign ESignature API.
- Updated the SDK release version.

## [v6.9.0] - eSignature API v2.1-22.1.02.00 - 2022-05-18
### Changed
- Added support for version v2.1-22.1.02.00 of the DocuSign ESignature API.
- Updated the SDK release version.

## [v6.8.0] - eSignature API v2.1-22.1.01.00 - 2022-04-07
### Changed
- Added support for version v2.1-22.1.01.00 of the DocuSign ESignature API.
- Updated the SDK release version.

### Breaking
- Following models are renamed

    - `ScheduledSendingApiModel` is renamed to `ScheduledSending`
    - `DelayedRoutingApiModel` is renamed to `DelayedRouting`

## [v6.7.1] - eSignature API v2.1-21.4.02.00 - 2022-03-15
### Fixed
- Issue - [`#165`](https://github.com/docusign/docusign-esign-php-client/issues/165):  Not working on php 8+ (DCM-7267)

## [v6.7.0] - eSignature API v2.1-21.4.02.00 - 2022-02-08
### Changed
- Added support for version v2.1-21.4.02.00 of the DocuSign ESignature API.
- Updated the SDK release version.

## [v6.6.0] - eSignature API v2.1-21.4.01.00 - 2022-01-06
### Changed
- Added support for version v2.1-21.4.01.00 of the DocuSign ESignature API.
- Updated the SDK release version.

## [6.6.0-rc] - ESignature API v2.1-21.4.00.00 - 2021-12-13
### Changed
- Added support for version v2.1-21.4.00.00 of the DocuSign ESignature API.
- Updated the SDK release version. 


## [6.5.0] - ESignature API v2.1-21.3.02.00 - 2021-10-29
### Changed
- Added support for version v2.1-21.3.02.00 of the DocuSign ESignature API.
- Updated the SDK release version.


## [6.5.0-rc] - ESignature API v2.1-21.3.00.00 - 2021-09-20
### Changed
- Added support for version v2.1-21.3.00.00 of the DocuSign ESignature API.
- Updated the SDK release version.


## [v6.4.0] - ESignature API v2.1-21.2.02.00 - 2021-09-02
### Changed
- Added support for version v2.1-21.2.02.00 of the DocuSign ESignature API.
- Updated the SDK release version.


## [v6.4.0-rc] - ESignature API v2.1-21.2.02.00 - 2021-08-19
### Breaking
- Removed `phone_number_metadata` from models `Agent`,`CarbonCopy`,`CertifiedDelivery`,`Editor`,`Intermediary`,`Signer`,`Witness`
### Changed
- Added support for version v2.1-21.2.02.00 of the DocuSign ESignature API.
- Updated the SDK release version.


## [v6.3.0] - ESignature API v2.1-21.2.00.00 - 2021-07-22
### Changed
- Added support for version v2.1-21.2.00.00 of the DocuSign ESignature API.
- Updated the SDK release version.


## [v6.3.0-rc] - eSignature API v2.1-21.2.00.00 - 2021-07-13
### Added
- Added new models and properties.
### Changed
- Added support for version v2.1-21.2.00.00 of the DocuSign eSignature API.
- Updated the SDK release version.

## [6.2.0] - eSignature API v2.1-21.1.02.00 - 2021-06-03
### Fixed
- Issue - EnvelopeFormData::get results in exception (DCM-5835)
- Issue - [`#138`](https://github.com/docusign/docusign-esign-php-client/issues/138):  Tabs class refers to `array` instead of `ModelList` (DCM-3768)

## [6.2.0-rc] - eSignature API v2.1-21.1.02.00 - 2021-05-20
### Breaking
- Removed methods `getAccountSettingsExport`,`getSealProviders` from Accounts.
- Removed methods `createConnectSecret`,`deleteConnectSecret`,`generateConnectSecret`,`getConnectSecrets` from Connect.
- Removed methods `getDynamicSystemSettings`,`getTemplateInfo`,`getApplianceInfo`,`getAccount`,`getCustomFields`,`deleteCustomFieldsV2`,`getDocumentPages`,`getImage`,`getLocalePolicy`,`updatePageInfo`,`createPageInfo`,`deletePageInfo`,`updatePdf`,`getPdf`,`getPdfBlob`,`updatePdfBlob`,`createPdfBlob`,`updateRecipientDeniedDocumentCopy`,`deleteRecipientDeniedDocumentCopy`,`getSignerAttachment`,`deleteSignerAttachment`, from Envelopes.
- Removed methods `completeSignHash`,`getUserInfo`,`healthCheck`,`signHashSessionInfo`,`updateTransaction` from TrustServiceProviders.
- Removed method `getUserListExport` from Users.
### Added
- Added new methods `getBulkSendBatchEnvelopes` to BulkEnvelopes.
### Changed
- Added support for version v2.1-21.1.02.00 of the DocuSign eSignature API.
- Updated the SDK release version.

## [6.1.0] - eSignature API v2.1-21.1.01.03 - 2021-04-23
### Added
- Added new methods `deleteCustomFieldsV2`, `deletePageInfoV2`, `getApplianceEnvelopeInfo`, `getTemplateInfo` to envelopes.
- Added new method `deleteConnectSecret` to connect.
### Changed
- Added support for version v2.1-21.1.01.03 of the DocuSign eSignature API.
- Updated the SDK release version.

## [6.1.0-rc] - eSignature API v2.1-21.1.01 - 2021-04-08
### Changed

*   Added nullable properties for the default initialization.
*   Added support for version v2.1-21.1.01 of the DocuSign eSignature API.
*   Updated the SDK release version.ccessed without initializing.

## [6.0.0-rc] - eSignature API v2.1-20.4.01 - 2021-01-15
### Changed

*   Upgraded SDK to PHP Version 7.
*   Added support for version v2.1-20.4.01 of the DocuSign eSignature API.
*   Updated the SDK release version.

### Breaking

*   As SDK is upgraded to PHP version 7, older versions of PHP will not be supported.
*   Exception might be thrown if a property of any model is accessed without initializing.

## [5.7.0] - eSignature API v2.1-20.3.01 - 2020-10-30
### Changed

*   Added support for version v2.1-20.3.01 of the DocuSign eSignature API.
*   Updated the SDK release version.

### Fixed

* Added Refresh Token
    * [#121](https://github.com/docusign/docusign-php-client/issues/121) - DCM-4819    
* Resolved Update Brand Resource issue
    * [#52](https://github.com/docusign/docusign-python-client/issues/52) - DCM-3869    

## [5.5.0] - eSignature API v2.1-20.3.00 - 2020-09-24
### Changed

*   Added support for version v2.1-20.3.00 of the DocuSign eSignature API.
*   Updated the SDK release version.

### Fixed

* Fixed APIException Serialization issue
    * [#83](https://github.com/docusign/docusign-php-client/issues/83) - DCM-3466
    * [#103](https://github.com/docusign/docusign-php-client/issues/103) - DCM-4286
    
## [5.4.0] - eSignature API v2.1-20.2.02 - 2020-08-25
### Changed

*   Added support for version v2.1-20.2.02 of the DocuSign eSignature API.
*   Updated the SDK release version.

## [5.3.0] - eSignature API v2.1-20.2.00 - 2020-07-09
### Changed

*   Added support for version v2.1-20.2.00 of the DocuSign eSignature API.
*   Updated the SDK release version.

### Fixed

* Fixed read member function issue in object serializer [#102](https://github.com/docusign/docusign-php-client/issues/102)

## [5.2.0] - eSignature API v2.1-20.1.02 - 2020-05-15
### Changed

*   Added support for version v2.1-20.1.02 of the DocuSign eSignature API.
*   Updated the SDK release version.

### Fixed

* Date serialization issues [#97](https://github.com/docusign/docusign-php-client/issues/97)

## [5.1.0] - eSignature API v2.1-20.1.00 - 2020-03-30
### Changed

*   Added support for version v2.1-20.1.00 of the DocuSign eSignature API.
*   Updated the SDK release version.

### Added

*   Added the new property `copy_recipient_data` to envelopes. When set to **true**, the information that recipients enter is retained when you clone an envelope. For example, if you resend an envelope that was declined or voided after one or more recipients entered data, that data is retained. Note that the new account UI setting `enable_envelope_copy_with_data` must be enabled for the account.
*   Added `input_options` and `RecipientIdentityInputOption` to `RecipientIdentityVerification` to support Identity Verification: Reserved for DocuSign.

## [5.0.0] - eSignature API v2-19.2.02 - 2019-09-28
### Changed
* The SDK now supports version 19.2.02 of the DocuSign eSignature API.
* SDK Release Version updated.git chec
### Fixed
* Number and Date serialization issues DCM-3210
* Updated phpdocs to point to new location of ApiException DCM-3372

## [4.0.0] - eSignature API v19.1.02 - 2019-06-07
### BREAKING
* Moved ApiClient and ApiException under Client folder
### Removed
* empty test placeholder files
### Changed
* updated existing test cases to use JWT instead of the legacy auth (still not fully working yet)
### Added
* OAuth models under Client/Auth folder
* new dependency for OAuth support (firebase/php-jwt)
* OAuthTests.php for OAuth support test
### Fixed
* A bug with that could cause the *moveEnvelopes* method call to return a response without a *Content-Type* header. (DCM-2871)

## [3.0.1] - Fixed the composer version - 2017-10-25

## [3.0.0] - Published all the DocuSign API endpoints - 2017-03-15

## [2.0.0] - New shiny PHP client - 2017-12-05

## [1.0.0] - Old legacy version - 2016-02-18
