Merge pull request #116 from docusign/3.1.0

Version 3.1.0 with full support of the Bulk Send API

Author: mmallis87

CHANGELOG.md

@@ -1,6 +1,10 @@
 # DocuSign Java Client Changelog
 See [DocuSign Support Center](https://support.docusign.com/en/releasenotes/) for Product Release Notes.
 
+## [v3.1.0] Full support of the Bulk Send API - 2019-06-26
+## Fixed
+- Issue [`#98`](https://github.com/docusign/docusign-java-client/issues/98): 411 Error thrown from BulkEnvelopesAPI updateRecipients call.
+
 ## [v3.0.1] - eSignature API v2.1-19.1.02 - 2019-06-25
 ### BREAKING
 - The SDK now supports version v2.1-19.1.02 of the DocuSign eSignature API.

README.md

@@ -34,7 +34,7 @@ Note: DocuSign uses **Eclipse** with **Maven** for testing purposes.
 <dependency>
   <groupId>com.docusign</groupId>
   <artifactId>docusign-esign-java</artifactId>
-  <version>3.0.1</version>
+  <version>3.1.0</version>
 </dependency>
 ```
 

pom.xml

@@ -4,7 +4,7 @@
   <artifactId>docusign-esign-java</artifactId>
   <packaging>jar</packaging>
   <name>docusign-esign-java</name>
-  <version>3.0.1</version>
+  <version>3.1.0</version>
   <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>
   <url>https://www.docusign.com/developer-center</url>
 

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

@@ -9,7 +9,6 @@
 
 import com.docusign.esign.model.BulkEnvelopeStatus;
 import com.docusign.esign.model.BulkEnvelopesResponse;
-import com.docusign.esign.model.BulkRecipientsRequest;
 import com.docusign.esign.model.BulkRecipientsResponse;
 import com.docusign.esign.model.BulkRecipientsSummaryResponse;
 import com.docusign.esign.model.BulkRecipientsUpdateResponse;
@@ -404,15 +403,20 @@ public BulkEnvelopesResponse list(String accountId, BulkEnvelopesApi.ListOptions
    * @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 bulkRecipientsRequest  (optional)
+   * @param bulkRecipientsRequest  (required)
    * @return BulkRecipientsSummaryResponse
    * @throws ApiException if fails to make API call
    */
-  public BulkRecipientsSummaryResponse updateRecipients(String accountId, String envelopeId, String recipientId, BulkRecipientsRequest bulkRecipientsRequest) throws ApiException {
+  public BulkRecipientsSummaryResponse updateRecipients(String accountId, String envelopeId, String recipientId, byte[] bulkRecipientsRequest) throws ApiException {
     Object localVarPostBody = bulkRecipientsRequest;
-    
-      // verify the required parameter 'accountId' is set
-      if (accountId == null) {
+
+    // verify the required parameter 'bulkRecipientsRequest' is set
+    if (bulkRecipientsRequest == null) {
+      throw new ApiException(400, "Missing the required parameter 'bulkRecipientsRequest' when calling updateRecipients");
+    }
+
+    // verify the required parameter 'accountId' is set
+    if (accountId == null) {
       throw new ApiException(400, "Missing the required parameter 'accountId' when calling updateRecipients");
       }
 

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

@@ -127,7 +127,7 @@ public ApiClient() {
     mapper.setDateFormat((DateFormat) dateFormat.clone());
 
     // Set default User-Agent.
-    setUserAgent("Swagger-Codegen/3.0.1/java");
+    setUserAgent("Swagger-Codegen/3.1.0/java");
 
     // Setup authentications (key: authentication name, value: authentication).
     authentications = new HashMap<String, Authentication>();
@@ -1244,7 +1244,9 @@ private String getXWWWFormUrlencodedParams(Map<String, Object> formParams) {
   private <T> String serializeToCsv(T obj) {
 	  if(obj == null) {
 	        return "";
-	  }
+	  } else if (obj.getClass() == byte[].class) {
+	    return new String((byte[]) obj);
+      }
 
 	  for (Method method: obj.getClass().getMethods()) {
 		  if ("java.util.List".equals(method.getReturnType().getName())) {

src/test/java/SdkUnitTests.java

@@ -1284,18 +1284,9 @@ public void UpdateBulkRecipientsTest() {
 			EnvelopeSummary envelopeSummary = envelopesApi.createEnvelope(accountId, envDef);
 
 			BulkEnvelopesApi bulkEnvelopesApi = new BulkEnvelopesApi();
-			BulkRecipientsRequest bulkRecipientsRequest = new BulkRecipientsRequest();
-
-			BulkRecipient bulkRecipient1 = new BulkRecipient();
-			bulkRecipient1.setName("John Doe");
-			bulkRecipient1.setEmail("[email protected]");
-
-			BulkRecipient bulkRecipient2 = new BulkRecipient();
-			bulkRecipient2.setName("Jane Doe");
-			bulkRecipient2.setEmail("[email protected]");
-
-			bulkRecipientsRequest.addBulkRecipientsItem(bulkRecipient1);
-			bulkRecipientsRequest.addBulkRecipientsItem(bulkRecipient2);
+			// Typically the Bulk Send CSV payload will come from a file, a DB query or an API call
+			String bulkRecipientsCSV = "name,email\n" + "John Doe,[email protected]\n" + "Jane Doe,[email protected]";
+			byte[] bulkRecipientsRequest = bulkRecipientsCSV.getBytes();
 
 			BulkRecipientsSummaryResponse bulkRecipientsSummaryResponse = bulkEnvelopesApi.updateRecipients(accountId, envelopeSummary.getEnvelopeId(), "1", bulkRecipientsRequest);
 			Assert.assertNotNull(bulkRecipientsSummaryResponse);