Version 5.0.0

Endpoint-Specific Changes

Updated EnvelopeRecipients: createRecipientProofFileResourceToken

The "token_scopes" parameter has been moved from path parameters to query parameters for the above mentioned endpoint.

Updated EnvelopeView:CreateSender and EnvelopeView: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

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

Version 5.0.0-RC1

Changed

• Added support for version v2.1-24.1.01.00 of the DocuSign ESignature API.
• Updated the SDK release version.

Version 4.6.0

BREAKING CHANGES

• Modified the default basePath to DEMO_REST_BASEPATH.

OTHER CHANGES

• Revised the logic to determine the oAuthBasePath based on the basePath.
• Added support for version v2.1-23.4.02.00 of the DocuSign ESignature API.
• Updated the SDK release version.

Version 4.6.0-RC1

BREAKING CHANGES

• Modified the default basePath to DEMO_REST_BASEPATH.

OTHER CHANGES

• Revised the logic to determine the oAuthBasePath based on the basePath.
• Added support for version v2.1-23.4.02.00 of the DocuSign ESignature API.
• Updated the SDK release version.

Version 4.5.0

Changed

• Added support for version v2.1-23.3.01.02 of the DocuSign ESignature API.
• Updated the SDK release version.

Version 4.4.0

Changed

• Added support for version v2.1-23.3.00.01 of the DocuSign ESignature API.
• Updated the SDK release version.

Version 4.3.0

Changed

• Added support for version v2.1-23.2.00.00 of the DocuSign ESignature API.
• Updated the SDK release version.

Version 4.2.0

Changed

• Added support for version v2.1-23.1.01.01 of the DocuSign ESignature API.
• Updated the SDK release version.

Version 4.1.0

Changed

• Added support for version v2.1-23.1.01.00 of the DocuSign ESignature API.
• Updated the SDK release version.

Version 4.0.0-RC1

Breaking Changes

• Migrated from Java EE to Jakarta
• Updated dependencies to the Jakarta supported versions

Migration Notes

• In order to use this version of the Java ESign SDK, clients must upgrade to Jakarta
• Clients that are unable to upgrade to Jakarta may reference the Uber JAR in order to maintain backwards compatibility