CHANGELOG.md in docusign_esign-4.0.0.rc1 vs CHANGELOG.md in docusign_esign-5.0.0.rc1

- old
+ new

@@ -1,9 +1,185 @@ # 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. +## [v5.0.0.rc1] - eSignature API v2.1-24.2.00.00 - 2024-06-28 +### 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. + +## [v4.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` + ## [v4.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.