Version 4.5.0-v2.1-23.3.01.02 release (#270)

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

Author: eleanorharris

CHANGELOG.md

@@ -1,6 +1,11 @@
 # DocuSign Java Client Changelog
 See [DocuSign Support Center](https://support.docusign.com/en/releasenotes/) for Product Release Notes.
 
+## [v4.5.0] - 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.
+
 ## [v4.4.0] - 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.

pom.xml

@@ -5,9 +5,9 @@
     <artifactId>docusign-esign-java</artifactId>
     <packaging>jar</packaging>
     <name>docusign-esign-java</name>
-    <version>4.4.0</version>
+    <version>4.5.0</version>
     <url>https://developers.docusign.com</url>
-    <description>The official DocuSign eSignature JAVA client is based on version 2 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>
+    <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>
 
     <prerequisites>
         <maven>2.2.0</maven>

src/main/java/com/docusign/esign/api/AccountsApi.java

@@ -4320,7 +4320,7 @@ public String getLangCode2() {
    * @param accountId The external account number (int) or account ID Guid. (required)
    * @param envelopeId The envelopeId Guid of the envelope being accessed. (required)
    * @param recipientId The ID of the recipient being accessed. (required)
-   * @param langCode The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. (required)
+   * @param langCode The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. (required)
    * @return ConsumerDisclosure
    */ 
   public ConsumerDisclosure getConsumerDisclosure(String accountId, String envelopeId, String recipientId, String langCode) throws ApiException {
@@ -4333,7 +4333,7 @@ public ConsumerDisclosure getConsumerDisclosure(String accountId, String envelop
    * @param accountId The external account number (int) or account ID Guid. (required)
    * @param envelopeId The envelopeId Guid of the envelope being accessed. (required)
    * @param recipientId The ID of the recipient being accessed. (required)
-   * @param langCode The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. (required)
+   * @param langCode The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. (required)
    * @param options for modifying the method behavior.
    * @return ConsumerDisclosure
    * @throws ApiException if fails to make API call
@@ -4349,7 +4349,7 @@ public ConsumerDisclosure getConsumerDisclosure(String accountId, String envelop
    * @param accountId The external account number (int) or account ID Guid. (required)
    * @param envelopeId The envelopeId Guid of the envelope being accessed. (required)
    * @param recipientId The ID of the recipient being accessed. (required)
-   * @param langCode The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. (required)
+   * @param langCode The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. (required)
    * @param options for modifying the method behavior.
    * @return ConsumerDisclosure
    * @throws ApiException if fails to make API call

src/main/java/com/docusign/esign/api/EnvelopesApi.java

@@ -2505,10 +2505,11 @@ public String getTransparentPng() {
    * @param userId The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
    * @param signatureId The ID of the signature being accessed. (required)
    * @param imageType One of **signature_image** or **initials_image**. (required)
+   * @param imageBytes Image content. (required)
    * @return UserSignature
    */ 
-  public UserSignature updateSignatureImage(String accountId, String userId, String signatureId, String imageType) throws ApiException {
-    return updateSignatureImage(accountId, userId, signatureId, imageType, null);
+  public UserSignature updateSignatureImage(String accountId, String userId, String signatureId, String imageType, byte[] imageBytes) throws ApiException {
+    return updateSignatureImage(accountId, userId, signatureId, imageType, imageBytes, null);
   }
 
   /**
@@ -2518,12 +2519,13 @@ public UserSignature updateSignatureImage(String accountId, String userId, Strin
    * @param userId The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
    * @param signatureId The ID of the signature being accessed. (required)
    * @param imageType One of **signature_image** or **initials_image**. (required)
+   * @param imageBytes Image content. (required)
    * @param options for modifying the method behavior.
    * @return UserSignature
    * @throws ApiException if fails to make API call
    */
-  public UserSignature updateSignatureImage(String accountId, String userId, String signatureId, String imageType, UsersApi.UpdateSignatureImageOptions options) throws ApiException {
-    ApiResponse<UserSignature> localVarResponse = updateSignatureImageWithHttpInfo(accountId, userId, signatureId, imageType, options);
+  public UserSignature updateSignatureImage(String accountId, String userId, String signatureId, String imageType, byte[] imageBytes, UsersApi.UpdateSignatureImageOptions options) throws ApiException {
+    ApiResponse<UserSignature> localVarResponse = updateSignatureImageWithHttpInfo(accountId, userId, signatureId, imageType, imageBytes, options);
     return localVarResponse.getData();
   }
 
@@ -2534,12 +2536,13 @@ public UserSignature updateSignatureImage(String accountId, String userId, Strin
    * @param userId The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
    * @param signatureId The ID of the signature being accessed. (required)
    * @param imageType One of **signature_image** or **initials_image**. (required)
+   * @param imageBytes Image content. (required)
    * @param options for modifying the method behavior.
    * @return UserSignature
    * @throws ApiException if fails to make API call
    */
-  public ApiResponse<UserSignature > updateSignatureImageWithHttpInfo(String accountId, String userId, String signatureId, String imageType, UsersApi.UpdateSignatureImageOptions options) throws ApiException {
-    Object localVarPostBody = "{}";
+  public ApiResponse<UserSignature > updateSignatureImageWithHttpInfo(String accountId, String userId, String signatureId, String imageType, byte[] imageBytes, UsersApi.UpdateSignatureImageOptions options) throws ApiException {
+    Object localVarPostBody = imageBytes;
 
     // verify the required parameter 'accountId' is set
     if (accountId == null) {
@@ -2561,6 +2564,11 @@ public ApiResponse<UserSignature > updateSignatureImageWithHttpInfo(String accou
       throw new ApiException(400, "Missing the required parameter 'imageType' when calling updateSignatureImage");
     }
 
+    // verify the required parameter 'imageBytes' is set
+    if (imageBytes == null) {
+      throw new ApiException(400, "Missing the required parameter 'imageBytes' when calling updateSignatureImage");
+    }
+    
     // create path and map variables
     String localVarPath = "/v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}/{imageType}"
       .replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()))

src/main/java/com/docusign/esign/api/UsersApi.java

@@ -96,7 +96,7 @@ public ApiClient() {
     String javaVersion = System.getProperty("java.version");
 
     // Set default User-Agent.
-    setUserAgent("/SDK/4.4.0/Java/");
+    setUserAgent("/SDK/4.5.0/Java/");
 
     // Setup authentications (key: authentication name, value: authentication).
     authentications = new HashMap<String, Authentication>();

src/main/java/com/docusign/esign/client/ApiClient.java

@@ -102,10 +102,10 @@ public DelayedRouting status(String status) {
   }
 
   /**
-   * Indicates the envelope status. Valid values are:  * sent - The envelope is sent to the recipients.  * created - The envelope is saved as a draft and can be modified and sent later..
+   * \\\"pending\\\" if the current workflow step has not been reached and the delay has not yet started. \\\"started\\\" if the delay is in progress. \\\"completed\\\" if the delay has elapsed and the envelope has been sent to the current workflow step's recipients..
    * @return status
    **/
-  @Schema(description = "Indicates the envelope status. Valid values are:  * sent - The envelope is sent to the recipients.  * created - The envelope is saved as a draft and can be modified and sent later.")
+  @Schema(description = "\\\"pending\\\" if the current workflow step has not been reached and the delay has not yet started. \\\"started\\\" if the delay is in progress. \\\"completed\\\" if the delay has elapsed and the envelope has been sent to the current workflow step's recipients.")
   public String getStatus() {
     return status;
   }