Version 5.1.0-v2.1-24.1.01.00 release (#282)

Co-authored-by: root <[email protected]>
docusign · Jun 25, 2024 · a39d994 · a39d994
1 parent 3baeff8
commit a39d994
Show file tree

Hide file tree

Showing 503 changed files with 2,119 additions and 533 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,17 @@
 # DocuSign Java Client Changelog
 See [DocuSign Support Center](https://support.docusign.com/en/releasenotes/) for Product Release Notes.
 
+## [v5.1.0] - eSignature API v2.1-24.1.01.00 - 2024-06-25
+# Changed
+
+- **Model classes are now serializable.**
+- **Resolved an issue** where setting a default SSL socket for the entire JVM caused unintended side effects.
+- **Fixed a memory leak** related to the class loader.
+- **Addressed dependency vulnerabilities** in the following libraries:
+  - `bcprov-jdk18on` updated to version 1.78.1
+  - `com.fasterxml.jackson.core` updated to version 2.17.1
+  - `org.json` updated to version 20240303
+  - `jersey` updated to version 3.1.6
 ## [v5.0.0] - eSignature API v2.1-24.1.01.00 - 2024-05-22
 ## Endpoint-Specific Changes
 

diff --git a/README.md b/README.md
@@ -1,20 +1,50 @@
-# The Official DocuSign eSignature Java Client SDK
+# The Official Docusign eSignature Java Client SDK
 
 [![Build status][travis-image]][travis-url]
 [![Maven Central status][maven-image]][maven-url]
 
+The Docusign SDK makes integrating Docusign into your apps and websites a seamless experience.
+
+## Table of Contents
+- [Introduction](#introduction)
+- [Installation](#installation)
+	* [Version Information](#versionInformation)
+	* [Requirements](#requirements)
+	* [Compatibility](#compatibility)
+	* [Maven](#maven)	
+- [Dependencies](#dependencies)
+- [API Reference](#apiReference)
+- [Code Examples](#codeExamples)
+- [OAuth Implementations](#oauthImplementations)
+- [Changelog](#changeLog)
+- [Support](#support)
+- [License](#license)
+- [Additional Resources](#additionalResources)
+
+<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 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 (Including prerelease)**: 
+
+<a id="requirements"></a>
 ## Requirements
 *   Java 1.9+
-*   Free [developer account](https://go.docusign.com/sandbox/productshot/?elqCampaignId=16531)
+*   Free [developer account](https://go.docusign.com/o/sandbox/?postActivateUrl=https://developers.docusign.com/)
 
+<a id="compatibility"></a>
 ## Compatibility
 *   Java 1.9+
 
-## 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.
-
-**Note:** DocuSign uses Eclipse with Maven for testing purposes.
-
+<a id="maven"></a>
+**Note:** Docusign uses Eclipse with Maven for testing purposes.
 ### Maven:
 1. In Eclipse, create a new project by selecting **File > New > Project**.
 2. In the New Project Wizard, expand **Maven,** then select **Maven Project.**
@@ -27,44 +57,62 @@ This SDK is provided as open source, which enables you to customize its function
     <dependency>
       <groupId>com.docusign</groupId>
       <artifactId>docusign-esign-java</artifactId>
-      <version>3.18.0</version>
+      <version>5.1.0</version>
     </dependency>
     ```
 8. If your project is still open, restart Eclipse.
 
-## Dependencies
+<a id="dependencies"></a>
+## SDK Dependencies
 This client has the following external dependencies:
-*   io.swagger:swagger-annotations:jar:1.5.17
-*   org.glassfish.jersey.core:jersey-client:jar:2.29.1
-*   org.glassfish.jersey.media:jersey-media-multipart:jar:2.29.1
-*   org.glassfish.jersey.media:jersey-media-json-jackson:2.29.1
-*   com.fasterxml.jackson.core:jackson-core:jar:2.12.1
-*   com.fasterxml.jackson.core:jackson-annotations:jar:2.12.1
-*   com.fasterxml.jackson.core:jackson-databind:2.12.1
-*   junit:junit:jar:4.13.1
-*   com.apache.oltu.oauth2:org.apache.oltu.oauth2.client:1.0.2
+*   io.swagger.core.v3:swagger-annotations:2.2.8
+*   org.glassfish.jersey.core:jersey-client:3.1.6
+*   org.glassfish.jersey.media:jersey-media-multipart:3.1.6
+*   org.glassfish.jersey.media:jersey-media-json-jackson:3.1.6
+*   org.glassfish.jersey.inject:jersey-hk2:3.1.6
+*   com.fasterxml.jackson.jakarta.rs:jackson-jakarta-rs-base:2.14.2
+*   org.apache.oltu.oauth2:org.apache.oltu.oauth2.client:1.0.2
 *   com.auth0:java-jwt:3.4.1
-*   org.bouncycastle:bcprov-jdk15on:1.60
+*   org.bouncycastle:bcprov-jdk18on:1.78.1
+*   com.fasterxml.jackson.dataformat:jackson-dataformat-csv:2.14.2
+*   com.fasterxml.jackson.datatype:jackson-datatype-jsr310:2.14.2
+*   com.brsanthu:migbase64:2.2
+*   com.fasterxml.jackson.core:jackson-core:2.17.1
+*   org.json:json:20240303
 
+
+<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 Java SDK, called a [Launcher](https://github.com/docusign/code-examples-java/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-java/), a self-executing package housing code examples for the eSignature Java 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/platform/auth/authcode/) flow.
 
-For security purposes, DocuSign recommends using the [Authorization Code Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant) flow.
+<a id="changeLog"></a>
+## Changelog
+You can refer to the complete changelog [here](https://github.com/docusign/docusign-esign-java-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 Java Client SDK is licensed under the [MIT License](https://github.com/docusign/docusign-java-client/blob/master/LICENSE).
+The Docusign eSignature Java Client SDK is licensed under the [MIT License](https://github.com/docusign/docusign-esign-java-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)
+*   [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://api.travis-ci.com/docusign/docusign-esign-java-client.svg?branch=master
 [travis-url]: https://app.travis-ci.com/github/docusign/docusign-esign-java-client

diff --git a/pom.xml b/pom.xml
@@ -5,7 +5,7 @@
     <artifactId>docusign-esign-java</artifactId>
     <packaging>jar</packaging>
     <name>docusign-esign-java</name>
-    <version>5.0.0</version>
+    <version>5.1.0</version>
     <url>https://developers.docusign.com</url>
     <description>The official DocuSign eSignature JAVA client is based on version 2.1 of the DocuSign REST API and provides libraries for JAVA application integration. It is recommended that you use this version of the library for new development.</description>
 
@@ -227,6 +227,21 @@
                     </execution>
                 </executions>
             </plugin>
+            <plugin>
+                <groupId>org.owasp</groupId>
+                <artifactId>dependency-check-maven</artifactId>
+                <version>9.2.0</version>
+                <configuration>
+                    <failBuildOnCVSS>8</failBuildOnCVSS>
+                </configuration>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>check</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-source-plugin</artifactId>
@@ -354,8 +369,8 @@
         </dependency>
         <dependency>
             <groupId>org.bouncycastle</groupId>
-            <artifactId>bcprov-jdk15on</artifactId>
-            <version>1.69</version>
+            <artifactId>bcprov-jdk18on</artifactId>
+            <version>1.78.1</version>
         </dependency>
         <dependency>
             <groupId>com.fasterxml.jackson.dataformat</groupId>
@@ -391,11 +406,27 @@
             <artifactId>migbase64</artifactId>
             <version>2.2</version>
         </dependency>
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter-api</artifactId>
+            <version>5.10.2</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-core</artifactId>
+            <version>2.17.1</version>
+        </dependency>
+        <dependency>
+            <groupId>org.json</groupId>
+            <artifactId>json</artifactId>
+            <version>20240303</version>
+        </dependency>
     </dependencies>
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <swagger-core-version>2.2.8</swagger-core-version>
-            <jersey-version>3.0.9</jersey-version>
+            <jersey-version>3.1.6</jersey-version>
         <jackson-version>2.14.2</jackson-version>
         <junit-version>4.13.1</junit-version>
         <oltu-version>1.0.2</oltu-version>

diff --git a/src/main/java/com/docusign/esign/client/ApiClient.java b/src/main/java/com/docusign/esign/client/ApiClient.java
@@ -96,7 +96,7 @@ public ApiClient() {
     String javaVersion = System.getProperty("java.version");
 
     // Set default User-Agent.
-    setUserAgent("Swagger-Codegen/v2.1/5.0.0/Java/" + javaVersion);
+    setUserAgent("Swagger-Codegen/v2.1/5.1.0/Java/" + javaVersion);
 
     // Setup authentications (key: authentication name, value: authentication).
     authentications = new HashMap<String, Authentication>();
@@ -1656,7 +1656,6 @@ protected Client buildHttpClient(boolean debugging) {
 	    } catch (final Exception ex) {
 	      System.err.println("failed to initialize SSL context");
 	    }
-	    HttpsURLConnection.setDefaultSSLSocketFactory(sslContext.getSocketFactory());
     }
 
     clientConfig.connectorProvider(new ConnectorProvider() {

diff --git a/src/main/java/com/docusign/esign/model/AccessCodeFormat.java b/src/main/java/com/docusign/esign/model/AccessCodeFormat.java
@@ -7,14 +7,17 @@
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonValue;
 import io.swagger.v3.oas.annotations.media.Schema;
+import java.io.Serializable;
 
 /**
  * Object specifying the format of the string provided to a recipient in order to access an envelope..
  *
  */
 @Schema(description = "Object specifying the format of the string provided to a recipient in order to access an envelope.")
 
-public class AccessCodeFormat {
+public class AccessCodeFormat implements Serializable {
+  private static final long serialVersionUID = 1L;
+
   @JsonProperty("formatRequired")
   private String formatRequired = null;
 

diff --git a/src/main/java/com/docusign/esign/model/AccountAddress.java b/src/main/java/com/docusign/esign/model/AccountAddress.java
@@ -7,14 +7,17 @@
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonValue;
 import io.swagger.v3.oas.annotations.media.Schema;
+import java.io.Serializable;
 
 /**
  * Contains information about an account address..
  *
  */
 @Schema(description = "Contains information about an account address.")
 
-public class AccountAddress {
+public class AccountAddress implements Serializable {
+  private static final long serialVersionUID = 1L;
+
   @JsonProperty("address1")
   private String address1 = null;
 

diff --git a/src/main/java/com/docusign/esign/model/AccountBillingPlan.java b/src/main/java/com/docusign/esign/model/AccountBillingPlan.java
@@ -10,14 +10,17 @@
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonValue;
 import io.swagger.v3.oas.annotations.media.Schema;
+import java.io.Serializable;
 
 /**
  * Contains information about an account billing plan..
  *
  */
 @Schema(description = "Contains information about an account billing plan.")
 
-public class AccountBillingPlan {
+public class AccountBillingPlan implements Serializable {
+  private static final long serialVersionUID = 1L;
+
   @JsonProperty("addOns")
   private java.util.List<AddOn> addOns = null;
 

diff --git a/src/main/java/com/docusign/esign/model/AccountBillingPlanResponse.java b/src/main/java/com/docusign/esign/model/AccountBillingPlanResponse.java
@@ -16,14 +16,17 @@
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonValue;
 import io.swagger.v3.oas.annotations.media.Schema;
+import java.io.Serializable;
 
 /**
  * Defines an account billing plan response object..
  *
  */
 @Schema(description = "Defines an account billing plan response object.")
 
-public class AccountBillingPlanResponse {
+public class AccountBillingPlanResponse implements Serializable {
+  private static final long serialVersionUID = 1L;
+
   @JsonProperty("billingAddress")
   private AccountAddress billingAddress = null;
 

diff --git a/src/main/java/com/docusign/esign/model/AccountIdentityInputOption.java b/src/main/java/com/docusign/esign/model/AccountIdentityInputOption.java
@@ -6,13 +6,16 @@
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonValue;
 import io.swagger.v3.oas.annotations.media.Schema;
+import java.io.Serializable;
 
 /**
  * AccountIdentityInputOption.
  *
  */
 
-public class AccountIdentityInputOption {
+public class AccountIdentityInputOption implements Serializable {
+  private static final long serialVersionUID = 1L;
+
   @JsonProperty("isRequired")
   private Boolean isRequired = null;
 

diff --git a/src/main/java/com/docusign/esign/model/AccountIdentityVerificationResponse.java b/src/main/java/com/docusign/esign/model/AccountIdentityVerificationResponse.java
@@ -7,13 +7,16 @@
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonValue;
 import io.swagger.v3.oas.annotations.media.Schema;
+import java.io.Serializable;
 
 /**
  * AccountIdentityVerificationResponse.
  *
  */
 
-public class AccountIdentityVerificationResponse {
+public class AccountIdentityVerificationResponse implements Serializable {
+  private static final long serialVersionUID = 1L;
+
   @JsonProperty("identityVerification")
   private java.util.List<AccountIdentityVerificationWorkflow> identityVerification = null;
 

diff --git a/src/main/java/com/docusign/esign/model/AccountIdentityVerificationStep.java b/src/main/java/com/docusign/esign/model/AccountIdentityVerificationStep.java
@@ -6,14 +6,17 @@
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonValue;
 import io.swagger.v3.oas.annotations.media.Schema;
+import java.io.Serializable;
 
 /**
  * Information about a specific step in an Identity Verification workflow..
  *
  */
 @Schema(description = "Information about a specific step in an Identity Verification workflow.")
 
-public class AccountIdentityVerificationStep {
+public class AccountIdentityVerificationStep implements Serializable {
+  private static final long serialVersionUID = 1L;
+
   @JsonProperty("name")
   private String name = null;
 

diff --git a/src/main/java/com/docusign/esign/model/AccountIdentityVerificationWorkflow.java b/src/main/java/com/docusign/esign/model/AccountIdentityVerificationWorkflow.java
@@ -9,14 +9,17 @@
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonValue;
 import io.swagger.v3.oas.annotations.media.Schema;
+import java.io.Serializable;
 
 /**
  * Specifies an Identity Verification workflow..
  *
  */
 @Schema(description = "Specifies an Identity Verification workflow.")
 
-public class AccountIdentityVerificationWorkflow {
+public class AccountIdentityVerificationWorkflow implements Serializable {
+  private static final long serialVersionUID = 1L;
+
   @JsonProperty("defaultDescription")
   private String defaultDescription = null;