Version 5.0.0-RC1-v2.1-24.1.01.00 release (#278)

Co-authored-by: root <root@devcenteradmin.docusigntest.com>

Author: asif-docusign

CHANGELOG.md

@@ -1,6 +1,11 @@
 # DocuSign Java Client Changelog
 See [DocuSign Support Center](https://support.docusign.com/en/releasenotes/) for Product Release Notes.
 
+## [v5.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.
+
 ## [v4.6.0] - eSignature API v2.1-23.4.02.00 - 2024-04-30
 ### BREAKING CHANGES
 - Modified the default basePath to `DEMO_REST_BASEPATH`.

pom.xml

@@ -5,7 +5,7 @@
     <artifactId>docusign-esign-java</artifactId>
     <packaging>jar</packaging>
     <name>docusign-esign-java</name>
-    <version>4.6.0</version>
+    <version>5.0.0-RC1</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>
 

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

@@ -794,12 +794,12 @@ public ApiResponse<Tabs > createDocumentTabsWithHttpInfo(String accountId, Strin
    * Returns a URL that allows you to embed the edit view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign editing view.   Upon sending completion, the user is returned to the return URL provided by the API application.  Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. 
    * @param accountId The external account number (int) or account ID Guid. (required)
    * @param envelopeId The envelopeId Guid of the envelope being accessed. (required)
-   * @param returnUrlRequest  (optional)
+   * @param envelopeViewRequest  (optional)
    * @return ViewUrl
    * @throws ApiException if fails to make API call
    */
-  public ViewUrl createEditView(String accountId, String envelopeId, ReturnUrlRequest returnUrlRequest) throws ApiException {
-    ApiResponse<ViewUrl> localVarResponse = createEditViewWithHttpInfo(accountId, envelopeId, returnUrlRequest);
+  public ViewUrl createEditView(String accountId, String envelopeId, EnvelopeViewRequest envelopeViewRequest) throws ApiException {
+    ApiResponse<ViewUrl> localVarResponse = createEditViewWithHttpInfo(accountId, envelopeId, envelopeViewRequest);
     return localVarResponse.getData();
   }
 
@@ -808,12 +808,12 @@ public ViewUrl createEditView(String accountId, String envelopeId, ReturnUrlRequ
    * Returns a URL that allows you to embed the edit view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign editing view.   Upon sending completion, the user is returned to the return URL provided by the API application.  Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. 
    * @param accountId The external account number (int) or account ID Guid. (required)
    * @param envelopeId The envelopeId Guid of the envelope being accessed. (required)
-   * @param returnUrlRequest  (optional)
+   * @param envelopeViewRequest  (optional)
    * @return ViewUrl
    * @throws ApiException if fails to make API call
    */
-  public ApiResponse<ViewUrl > createEditViewWithHttpInfo(String accountId, String envelopeId, ReturnUrlRequest returnUrlRequest) throws ApiException {
-    Object localVarPostBody = returnUrlRequest;
+  public ApiResponse<ViewUrl > createEditViewWithHttpInfo(String accountId, String envelopeId, EnvelopeViewRequest envelopeViewRequest) throws ApiException {
+    Object localVarPostBody = envelopeViewRequest;
 
     // verify the required parameter 'accountId' is set
     if (accountId == null) {
@@ -1849,40 +1849,75 @@ public ApiResponse<IdEvidenceViewLink > createRecipientProofFileLinkWithHttpInfo
     IdEvidenceViewLink localVarResponse = apiClient.invokeAPI(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
     return new ApiResponse<IdEvidenceViewLink>(apiClient.getStatusCode(), apiClient.getResponseHeaders(), localVarResponse);
   }
+  /// <summary>
+  /// Returns a resource token to get access to the identity events stored in the proof service related to this recipient. Creates a resource token for a sender. This token allows a sender to return identification data for a recipient using the [ID Evidence API](/docs/idevidence-api/).
+  /// </summary>
+
+ /**
+  * CreateRecipientProofFileResourceTokenOptions Class.
+  *
+  **/
+  public class CreateRecipientProofFileResourceTokenOptions
+  {
+  private String tokenScopes = null;
+  
+ /**
+  * setTokenScopes method.
+  */
+  public void setTokenScopes(String tokenScopes) {
+    this.tokenScopes = tokenScopes;
+  }
+
+ /**
+  * getTokenScopes method.
+  *
+  * @return String
+  */
+  public String getTokenScopes() {
+    return this.tokenScopes;
+  }
+  }
+
+   /**
+   * Returns a resource token to get access to the identity events stored in the proof service related to this recipient..
+   * Creates a resource token for a sender. This token allows a sender to return identification data for a recipient using the [ID Evidence API](/docs/idevidence-api/).
+   * @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)
+   * @return IdEvidenceResourceToken
+   */ 
+  public IdEvidenceResourceToken createRecipientProofFileResourceToken(String accountId, String envelopeId, String recipientId) throws ApiException {
+    return createRecipientProofFileResourceToken(accountId, envelopeId, recipientId, null);
+  }
 
   /**
    * Returns a resource token to get access to the identity events stored in the proof service related to this recipient..
    * Creates a resource token for a sender. This token allows a sender to return identification data for a recipient using the [ID Evidence API](/docs/idevidence-api/).
-   * @param tokenScopes  (required)
    * @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 options for modifying the method behavior.
    * @return IdEvidenceResourceToken
    * @throws ApiException if fails to make API call
    */
-  public IdEvidenceResourceToken createRecipientProofFileResourceToken(String tokenScopes, String accountId, String envelopeId, String recipientId) throws ApiException {
-    ApiResponse<IdEvidenceResourceToken> localVarResponse = createRecipientProofFileResourceTokenWithHttpInfo(tokenScopes, accountId, envelopeId, recipientId);
+  public IdEvidenceResourceToken createRecipientProofFileResourceToken(String accountId, String envelopeId, String recipientId, EnvelopesApi.CreateRecipientProofFileResourceTokenOptions options) throws ApiException {
+    ApiResponse<IdEvidenceResourceToken> localVarResponse = createRecipientProofFileResourceTokenWithHttpInfo(accountId, envelopeId, recipientId, options);
     return localVarResponse.getData();
   }
 
   /**
    * Returns a resource token to get access to the identity events stored in the proof service related to this recipient.
    * Creates a resource token for a sender. This token allows a sender to return identification data for a recipient using the [ID Evidence API](/docs/idevidence-api/).
-   * @param tokenScopes  (required)
    * @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 options for modifying the method behavior.
    * @return IdEvidenceResourceToken
    * @throws ApiException if fails to make API call
    */
-  public ApiResponse<IdEvidenceResourceToken > createRecipientProofFileResourceTokenWithHttpInfo(String tokenScopes, String accountId, String envelopeId, String recipientId) throws ApiException {
+  public ApiResponse<IdEvidenceResourceToken > createRecipientProofFileResourceTokenWithHttpInfo(String accountId, String envelopeId, String recipientId, EnvelopesApi.CreateRecipientProofFileResourceTokenOptions options) throws ApiException {
     Object localVarPostBody = "{}";
 
-    // verify the required parameter 'tokenScopes' is set
-    if (tokenScopes == null) {
-      throw new ApiException(400, "Missing the required parameter 'tokenScopes' when calling createRecipientProofFileResourceToken");
-    }
-    
     // verify the required parameter 'accountId' is set
     if (accountId == null) {
       throw new ApiException(400, "Missing the required parameter 'accountId' when calling createRecipientProofFileResourceToken");
@@ -1900,7 +1935,6 @@ public ApiResponse<IdEvidenceResourceToken > createRecipientProofFileResourceTok
 
     // create path and map variables
     String localVarPath = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/identity_proof_token"
-      .replaceAll("\\{" + "token_scopes" + "\\}", apiClient.escapeString(tokenScopes.toString()))
       .replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()))
       .replaceAll("\\{" + "envelopeId" + "\\}", apiClient.escapeString(envelopeId.toString()))
       .replaceAll("\\{" + "recipientId" + "\\}", apiClient.escapeString(recipientId.toString()));
@@ -1911,7 +1945,9 @@ public ApiResponse<IdEvidenceResourceToken > createRecipientProofFileResourceTok
     java.util.Map<String, String> localVarHeaderParams = new java.util.HashMap<String, String>();
     java.util.Map<String, Object> localVarFormParams = new java.util.HashMap<String, Object>();
 
-    
+    if (options != null) {
+      localVarQueryParams.addAll(apiClient.parameterToPair("token_scopes", options.tokenScopes));
+    }
 
 
 
@@ -2079,12 +2115,12 @@ public ApiResponse<DocumentHtmlDefinitions > createResponsiveHtmlPreviewWithHttp
    * Returns a URL that allows you to embed the sender view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign sending view.   Upon sending completion, the user is returned to the return URL provided by the API application.  Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. 
    * @param accountId The external account number (int) or account ID Guid. (required)
    * @param envelopeId The envelopeId Guid of the envelope being accessed. (required)
-   * @param returnUrlRequest  (optional)
+   * @param envelopeViewRequest  (optional)
    * @return ViewUrl
    * @throws ApiException if fails to make API call
    */
-  public ViewUrl createSenderView(String accountId, String envelopeId, ReturnUrlRequest returnUrlRequest) throws ApiException {
-    ApiResponse<ViewUrl> localVarResponse = createSenderViewWithHttpInfo(accountId, envelopeId, returnUrlRequest);
+  public ViewUrl createSenderView(String accountId, String envelopeId, EnvelopeViewRequest envelopeViewRequest) throws ApiException {
+    ApiResponse<ViewUrl> localVarResponse = createSenderViewWithHttpInfo(accountId, envelopeId, envelopeViewRequest);
     return localVarResponse.getData();
   }
 
@@ -2093,12 +2129,12 @@ public ViewUrl createSenderView(String accountId, String envelopeId, ReturnUrlRe
    * Returns a URL that allows you to embed the sender view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign sending view.   Upon sending completion, the user is returned to the return URL provided by the API application.  Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. 
    * @param accountId The external account number (int) or account ID Guid. (required)
    * @param envelopeId The envelopeId Guid of the envelope being accessed. (required)
-   * @param returnUrlRequest  (optional)
+   * @param envelopeViewRequest  (optional)
    * @return ViewUrl
    * @throws ApiException if fails to make API call
    */
-  public ApiResponse<ViewUrl > createSenderViewWithHttpInfo(String accountId, String envelopeId, ReturnUrlRequest returnUrlRequest) throws ApiException {
-    Object localVarPostBody = returnUrlRequest;
+  public ApiResponse<ViewUrl > createSenderViewWithHttpInfo(String accountId, String envelopeId, EnvelopeViewRequest envelopeViewRequest) throws ApiException {
+    Object localVarPostBody = envelopeViewRequest;
 
     // verify the required parameter 'accountId' is set
     if (accountId == null) {

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

@@ -207,12 +207,12 @@ public ApiResponse<DocumentFieldsInformation > createDocumentFieldsWithHttpInfo(
    * This method returns a URL for starting an edit view of a template that uses the DocuSign Template UI.
    * @param accountId The external account number (int) or account ID Guid. (required)
    * @param templateId The ID of the template being accessed. (required)
-   * @param returnUrlRequest  (optional)
+   * @param templateViewRequest  (optional)
    * @return ViewUrl
    * @throws ApiException if fails to make API call
    */
-  public ViewUrl createEditView(String accountId, String templateId, ReturnUrlRequest returnUrlRequest) throws ApiException {
-    ApiResponse<ViewUrl> localVarResponse = createEditViewWithHttpInfo(accountId, templateId, returnUrlRequest);
+  public ViewUrl createEditView(String accountId, String templateId, TemplateViewRequest templateViewRequest) throws ApiException {
+    ApiResponse<ViewUrl> localVarResponse = createEditViewWithHttpInfo(accountId, templateId, templateViewRequest);
     return localVarResponse.getData();
   }
 
@@ -221,12 +221,12 @@ public ViewUrl createEditView(String accountId, String templateId, ReturnUrlRequ
    * This method returns a URL for starting an edit view of a template that uses the DocuSign Template UI.
    * @param accountId The external account number (int) or account ID Guid. (required)
    * @param templateId The ID of the template being accessed. (required)
-   * @param returnUrlRequest  (optional)
+   * @param templateViewRequest  (optional)
    * @return ViewUrl
    * @throws ApiException if fails to make API call
    */
-  public ApiResponse<ViewUrl > createEditViewWithHttpInfo(String accountId, String templateId, ReturnUrlRequest returnUrlRequest) throws ApiException {
-    Object localVarPostBody = returnUrlRequest;
+  public ApiResponse<ViewUrl > createEditViewWithHttpInfo(String accountId, String templateId, TemplateViewRequest templateViewRequest) throws ApiException {
+    Object localVarPostBody = templateViewRequest;
 
     // verify the required parameter 'accountId' is set
     if (accountId == null) {

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/4.6.0/Java/" + javaVersion);
+    setUserAgent("Swagger-Codegen/v2.1/5.0.0-RC1/Java/" + javaVersion);
 
     // Setup authentications (key: authentication name, value: authentication).
     authentications = new HashMap<String, Authentication>();