Merge branch 'master' into feature/updates-for-example-38

annahileta · web-flow · commit 51fbae19c8bc · 2023-10-17T11:43:44.000+03:00
Signed-off-by: Anna Hileta &lt;80112359+annahileta@users.noreply.github.com&gt;
diff --git a/src/main/java/com/docusign/controller/admin/services/AddActiveUserService.java b/src/main/java/com/docusign/controller/admin/services/AddActiveUserService.java
@@ -7,7 +7,7 @@
 import java.util.UUID;
 
 public  class AddActiveUserService {
-
+    //ds-snippet-start:Admin1Step5
     public static NewUserResponse createNewActiveUser(
             String groupId,
             String profileId,
@@ -19,7 +19,6 @@ public static NewUserResponse createNewActiveUser(
             UUID organizationId,
             UUID accountId) throws Exception
     {
-        //ds-snippet-start:Admin1Step5
         java.util.List<GroupRequest> groups = new ArrayList<>();
         groups.add(new GroupRequest().id(Long.valueOf(groupId)));
 
diff --git a/src/main/java/com/docusign/controller/admin/services/UserDataManagementService.java b/src/main/java/com/docusign/controller/admin/services/UserDataManagementService.java
@@ -51,13 +51,13 @@ public IndividualUserDataRedactionResponse deleteUserDataFromOrganizationByEmail
 			memberships.accountId(user.getMemberships().get(0).getAccountId());
 		}
 
-		//ds-snippet-start:Admin11Step3
+		//ds-snippet-start:Admin10Step3
 		IndividualUserDataRedactionRequest userRedactionRequest = new IndividualUserDataRedactionRequest();
 		userRedactionRequest.setUserId(user.getId());
 		userRedactionRequest.setMemberships(Arrays.asList(memberships));
-		//ds-snippet-end:Admin11Step3
-		//ds-snippet-start:Admin11Step4
+		//ds-snippet-end:Admin10Step3
+		//ds-snippet-start:Admin10Step4
 		return organizationsApi.redactIndividualUserData(organizationId, userRedactionRequest);
-		//ds-snippet-end:Admin11Step4
+		//ds-snippet-end:Admin10Step4
 	}
 }
diff --git a/src/main/java/com/docusign/controller/eSignature/examples/EG003ControllerListEnvelopes.java b/src/main/java/com/docusign/controller/eSignature/examples/EG003ControllerListEnvelopes.java
@@ -32,18 +32,18 @@ public EG003ControllerListEnvelopes(DSConfiguration config, Session session, Use
     }
 
     @Override
-    // ***DS.snippet.0.start
     protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse response) throws ApiException {
+        //ds-snippet-start:eSign3Step2
         EnvelopesApi envelopesApi = createEnvelopesApi(session.getBasePath(), user.getAccessToken());
         EnvelopesInformation envelopesInformation = ListEnvelopesServices.listEnvelopes(
                 envelopesApi,
                 session.getAccountId());
+        //ds-snippet-end:eSign3Step2
 
         DoneExample.createDefault(getTextForCodeExampleByApiType().ExampleName)
                 .withMessage(getTextForCodeExampleByApiType().ResultsPageText)
                 .withJsonObject(envelopesInformation)
                 .addToModel(model, config);
         return DONE_EXAMPLE_PAGE;
     }
-    // ***DS.snippet.0.end
 }
diff --git a/src/main/java/com/docusign/controller/eSignature/examples/EG010ControllerSendBinaryDocs.java b/src/main/java/com/docusign/controller/eSignature/examples/EG010ControllerSendBinaryDocs.java
@@ -31,7 +31,6 @@ public EG010ControllerSendBinaryDocs(DSConfiguration config, Session session, Us
     }
 
     @Override
-    // ***DS.snippet.0.start
     protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse response) throws IOException {
         String responseString = SendBinaryDocsService.sendBinaryDocs(
                 args,
@@ -54,5 +53,4 @@ protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse
                 .addToModel(model, config);
         return DONE_EXAMPLE_PAGE;
     }
-    // ***DS.snippet.0.end
 }
diff --git a/src/main/java/com/docusign/controller/eSignature/examples/EG023ControllerIdvAuthentication.java b/src/main/java/com/docusign/controller/eSignature/examples/EG023ControllerIdvAuthentication.java
@@ -41,22 +41,18 @@ public EG023ControllerIdvAuthentication(DSConfiguration config, Session session,
 
     @Override
     protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse response) throws ApiException, IOException {
-        // Step 2 start
         ApiClient apiClient = createApiClient(session.getBasePath(), user.getAccessToken());
-        // Step 2 end
         EnvelopesApi envelopesApi = new EnvelopesApi(apiClient);
         String workflowId = IdvAuthenticationService.retrieveWorkflowId(apiClient, session.getAccountId());
         logger.info("workflowId = " + workflowId);
         if (workflowId.equals(""))
         {
             throw new ApiException(0, getTextForCodeExampleByApiType().CustomErrorTexts.get(0).ErrorMessage);
         }
-        // Step 4-1 start
         EnvelopeDefinition envelope = IdvAuthenticationService.createEnvelope(args.getSignerName(), args.getSignerEmail(), workflowId);
-        // Step 4-1 end
-        // Step 5 start
+        //ds-snippet-start:eSign23Step5
         EnvelopeSummary results = IdvAuthenticationService.idvAuthentication(envelopesApi, session.getAccountId(), envelope);
-        // Step 5 end
+        //ds-snippet-end:eSign23Step5
 
         session.setEnvelopeId(results.getEnvelopeId());
         DoneExample.createDefault(getTextForCodeExampleByApiType().ExampleName)
diff --git a/src/main/java/com/docusign/controller/eSignature/examples/EG038ControllerResponsiveSigning.java b/src/main/java/com/docusign/controller/eSignature/examples/EG038ControllerResponsiveSigning.java
@@ -34,7 +34,7 @@ public EG038ControllerResponsiveSigning(DSConfiguration config, Session session,
     }
 
     @Override
-	// Step 3 start
+	//ds-snippet-start:eSign38Step3
     protected Object doWork(WorkArguments args, ModelMap model,
 					   HttpServletResponse response) throws ApiException, IOException {
 	   String signerName = args.getSignerName();
@@ -84,5 +84,5 @@ protected Object doWork(WorkArguments args, ModelMap model,
 
 	   return new RedirectView(viewUrl.getUrl());
     }
-	// Step 3 end
+	//ds-snippet-end:eSign38Step3
 }
diff --git a/src/main/java/com/docusign/controller/eSignature/services/CollectPaymentService.java b/src/main/java/com/docusign/controller/eSignature/services/CollectPaymentService.java
@@ -26,14 +26,16 @@ public final class CollectPaymentService {
     private static final String DEFAULT_FONT_SIZE = "size11";
     private static final String ANCHOR_UNITS = "pixels";
 
+    //ds-snippet-start:eSign14Step4
     public static EnvelopeSummary collectPayment(
             EnvelopesApi envelopesApi,
             EnvelopeDefinition envelope,
             String accountId
             ) throws ApiException {
-        // Step 2. call Envelopes::create API method
+        // Call Envelopes::create API method
         return envelopesApi.createEnvelope(accountId, envelope);
     }
+    //ds-snippet-end:eSign14Step4
     // document 1 (html) has multiple tags:
     // /l1q/ and /l2q/ -- quantities: drop down
     // /l1e/ and /l2e/ -- extended: payment lines
@@ -44,6 +46,7 @@ public static EnvelopeSummary collectPayment(
     // recipient 2 - cc
     // The envelope will be sent first to the signer.
     // After it is signed, a copy is sent to the cc person.
+    //ds-snippet-start:eSign14Step3
     public static EnvelopeDefinition makeEnvelope(
             String signerEmail,
             String signerName,
@@ -184,4 +187,5 @@ private static FormulaTab createFormulaTab(String anchor, String label, int pric
                 .locked(TRUE)
                 .disableAutoSize(FALSE);
     }
+    //ds-snippet-end:eSign14Step3
 }
diff --git a/src/main/java/com/docusign/controller/eSignature/services/EnvelopeGetDocService.java b/src/main/java/com/docusign/controller/eSignature/services/EnvelopeGetDocService.java
@@ -12,7 +12,9 @@ public static byte[] envelopeGetDoc(
             String envelopeId,
             String documentId
     ) throws ApiException {
+        //ds-snippet-start:eSign7Step3
         return envelopesApi.getDocument(accountId, envelopeId, documentId);
+        //ds-snippet-end:eSign7Step3
     }
 
     public static String addExtension(String fileName, String extension) {
diff --git a/src/main/java/com/docusign/controller/eSignature/services/EnvelopeInfoService.java b/src/main/java/com/docusign/controller/eSignature/services/EnvelopeInfoService.java
@@ -4,6 +4,7 @@
 import com.docusign.esign.client.ApiException;
 import com.docusign.esign.model.Envelope;
 
+//ds-snippet-start:eSign4Step2
 public final class EnvelopeInfoService {
     public static Envelope envelopeInfo(
             EnvelopesApi envelopesApi,
@@ -13,3 +14,4 @@ public static Envelope envelopeInfo(
         return envelopesApi.getEnvelope(accountId, envelopeId);
     }
 }
+//ds-snippet-end:eSign4Step2
diff --git a/src/main/java/com/docusign/controller/eSignature/services/IdvAuthenticationService.java b/src/main/java/com/docusign/controller/eSignature/services/IdvAuthenticationService.java
@@ -24,7 +24,7 @@ public static EnvelopeSummary idvAuthentication(
     }
 
     public static String retrieveWorkflowId(ApiClient apiClient, String accountId) throws ApiException {
-        // Step 3 start
+        //ds-snippet-start:eSign23Step3
         AccountsApi workflowDetails = new AccountsApi(apiClient);
         AccountIdentityVerificationResponse workflowRes = workflowDetails.getAccountIdentityVerification(accountId);
         List<AccountIdentityVerificationWorkflow> identityVerification = workflowRes.getIdentityVerification();
@@ -37,9 +37,10 @@ public static String retrieveWorkflowId(ApiClient apiClient, String accountId) t
             }
         }
         return  workflowId;
-        // Step 3 end
+        //ds-snippet-end:eSign23Step3
     }
 
+    //ds-snippet-start:eSign23Step4
     public static EnvelopeDefinition createEnvelope(
             String signerName,
             String signerEmail,
@@ -99,4 +100,5 @@ public static EnvelopeDefinition createEnvelope(
         envelopeDefinition.setDocuments(Collections.singletonList(doc1));
         return envelopeDefinition;
     }
+    //ds-snippet-end:eSign23Step4
 }
diff --git a/src/main/java/com/docusign/controller/eSignature/services/KBAAuthenticationService.java b/src/main/java/com/docusign/controller/eSignature/services/KBAAuthenticationService.java
@@ -17,9 +17,12 @@ public static EnvelopeSummary kbaAuthentication(
             String accountId,
             EnvelopeDefinition envelope
     ) throws ApiException {
+        //ds-snippet-start:eSign22Step4
         return envelopesApi.createEnvelope(accountId, envelope);
+        //ds-snippet-end:eSign22Step4
     }
 
+    //ds-snippet-start:eSign22Step3
     public static Signer setSignHereAndSignerForEnvelope(
             String signerName,
             String signerEmail) throws IOException {
@@ -69,4 +72,5 @@ public static EnvelopeDefinition createEnvelope(
 
         return envelope;
     }
+    //ds-snippet-end:eSign22Step3
 }
diff --git a/src/main/java/com/docusign/controller/eSignature/services/PermissionCreateService.java b/src/main/java/com/docusign/controller/eSignature/services/PermissionCreateService.java
@@ -16,6 +16,7 @@ public static PermissionProfile createNewProfile(
     ) throws ApiException {
         // Step 3. Construct your request body
         // We're extending the AccountSettings class with AccountSettingsPatch to include the signingUIVersion which is missing in the swagger spec at this time.
+        //ds-snippet-start:eSign24Step3
         Gson gson = new Gson();
         String signingUiVersion = "1";
         AccountRoleSettings settings = DsModelUtils.createDefaultRoleSettings();
@@ -24,8 +25,11 @@ public static PermissionProfile createNewProfile(
         PermissionProfile profile = new PermissionProfile()
                 .permissionProfileName(permissionProfileName)
                 .settings(newSettings);
+        //ds-snippet-end:eSign24Step3
 
         // Step 4. Call the eSignature REST API
+        //ds-snippet-start:eSign24Step4
         return accountsApi.createPermissionProfile(accountId, profile);
+        //ds-snippet-end:eSign24Step4
     }
 }
diff --git a/src/main/java/com/docusign/controller/eSignature/services/ResponsiveSigningService.java b/src/main/java/com/docusign/controller/eSignature/services/ResponsiveSigningService.java
@@ -12,7 +12,7 @@
 import java.util.Collections;
 
 public final class ResponsiveSigningService {
-    // Step 2 start
+    //ds-snippet-start:eSign38Step2
     private static final String TRUE = "true";
     private static final String FALSE = "false";
     private static final int L1_PRICE = 5;
@@ -136,5 +136,5 @@ public static RecipientViewRequest makeRecipientViewRequest(
 
         return viewRequest;
     }
-    // Step 2 end
+    //ds-snippet-end:eSign38Step2
 }
diff --git a/src/main/java/com/docusign/controller/eSignature/services/SendBinaryDocsService.java b/src/main/java/com/docusign/controller/eSignature/services/SendBinaryDocsService.java
@@ -48,7 +48,6 @@ public static String sendBinaryDocs(
             String accountId,
             String accessToken
     ) throws IOException {
-        // Step 1. Gather documents and their headers
         List<DocumentInfo> documents = List.of(
                 new DocumentInfo(HTML_DOCUMENT_NAME, "1", DocumentType.HTML,
                         EnvelopeHelpers.createHtmlFromTemplateFile(HTML_DOCUMENT_FILE_NAME, "args", args)
@@ -59,15 +58,15 @@ public static String sendBinaryDocs(
                         EnvelopeHelpers.readFile(PDF_DOCUMENT_FILE_NAME))
         );
 
-        // Step 2. Make the envelope JSON request body
+        // Make the envelope JSON request body
         JSONObject envelopeJSON = SendBinaryDocsService.makeEnvelopeJSON(
             signerName,
             signerEmail,
             ccName,
             ccEmail,
             documents);
 
-        // Step 3. Create the multipart body
+        // Create the multipart body
         URL uri = new URL(String.format("%s/v2.1/accounts/%s/envelopes", basePath, accountId));
         String contentType = String.join(
                 "",
@@ -81,6 +80,7 @@ public static String sendBinaryDocs(
         connection.setDoOutput(true);
 
         // See https://developers.docusign.com/esign-rest-api/guides/requests-and-responses
+        //ds-snippet-start:eSign10Step4
         DataOutputStream buffer = new DataOutputStream(connection.getOutputStream());
         SendBinaryDocsService.writeBoundaryHeader(buffer, MediaType.APPLICATION_JSON, "form-data");
         buffer.writeBytes(envelopeJSON.toString(DoneExample.JSON_INDENT_FACTOR));
@@ -102,6 +102,7 @@ public static String sendBinaryDocs(
 
         return StreamUtils.copyToString(connection.getInputStream(), StandardCharsets.UTF_8);
     }
+    //ds-snippet-end:eSign10Step4
 
     private static void writeBoundaryHeader(
             DataOutputStream buffer,
@@ -136,6 +137,7 @@ private static void writeClosingBoundary(DataOutputStream buffer) throws IOExcep
     // recipient 2 - cc
     // The envelope will be sent first to the signer.
     // After it is signed, a copy is sent to the cc person.
+    //ds-snippet-start:eSign10Step3
     private static JSONObject makeEnvelopeJSON(
             String signerName,
             String signerEmail,
@@ -189,6 +191,7 @@ private static JSONObject makeEnvelopeJSON(
 
         return envelopeJSON;
     }
+    //ds-snippet-end:eSign10Step3
     @Value
     public static class DocumentInfo {
         String name;

Original file line number	Diff line number	Diff line change
`@@ -51,13 +51,13 @@ public IndividualUserDataRedactionResponse deleteUserDataFromOrganizationByEmail`
`51`	`51`	`memberships.accountId(user.getMemberships().get(0).getAccountId());`
`52`	`52`	`}`
`53`	`53`
`54`		`- //ds-snippet-start:Admin11Step3`
	`54`	`+ //ds-snippet-start:Admin10Step3`
`55`	`55`	`IndividualUserDataRedactionRequest userRedactionRequest = new IndividualUserDataRedactionRequest();`
`56`	`56`	`userRedactionRequest.setUserId(user.getId());`
`57`	`57`	`userRedactionRequest.setMemberships(Arrays.asList(memberships));`
`58`		`- //ds-snippet-end:Admin11Step3`
`59`		`- //ds-snippet-start:Admin11Step4`
	`58`	`+ //ds-snippet-end:Admin10Step3`
	`59`	`+ //ds-snippet-start:Admin10Step4`
`60`	`60`	`return organizationsApi.redactIndividualUserData(organizationId, userRedactionRequest);`
`61`		`- //ds-snippet-end:Admin11Step4`
	`61`	`+ //ds-snippet-end:Admin10Step4`
`62`	`62`	`}`
`63`	`63`	`}`
Original file line number	Diff line number	Diff line change
`@@ -32,18 +32,18 @@ public EG003ControllerListEnvelopes(DSConfiguration config, Session session, Use`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`@Override`
`35`		`- // ***DS.snippet.0.start`
`36`	`35`	`protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse response) throws ApiException {`
	`36`	`+ //ds-snippet-start:eSign3Step2`
`37`	`37`	`EnvelopesApi envelopesApi = createEnvelopesApi(session.getBasePath(), user.getAccessToken());`
`38`	`38`	`EnvelopesInformation envelopesInformation = ListEnvelopesServices.listEnvelopes(`
`39`	`39`	`envelopesApi,`
`40`	`40`	`session.getAccountId());`
	`41`	`+ //ds-snippet-end:eSign3Step2`
`41`	`42`
`42`	`43`	`DoneExample.createDefault(getTextForCodeExampleByApiType().ExampleName)`
`43`	`44`	`.withMessage(getTextForCodeExampleByApiType().ResultsPageText)`
`44`	`45`	`.withJsonObject(envelopesInformation)`
`45`	`46`	`.addToModel(model, config);`
`46`	`47`	`return DONE_EXAMPLE_PAGE;`
`47`	`48`	`}`
`48`		`- // ***DS.snippet.0.end`
`49`	`49`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,6 @@ public EG010ControllerSendBinaryDocs(DSConfiguration config, Session session, Us`
`31`	`31`	`}`
`32`	`32`
`33`	`33`	`@Override`
`34`		`- // ***DS.snippet.0.start`
`35`	`34`	`protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse response) throws IOException {`
`36`	`35`	`String responseString = SendBinaryDocsService.sendBinaryDocs(`
`37`	`36`	`args,`
`@@ -54,5 +53,4 @@ protected Object doWork(WorkArguments args, ModelMap model, HttpServletResponse`
`54`	`53`	`.addToModel(model, config);`
`55`	`54`	`return DONE_EXAMPLE_PAGE;`
`56`	`55`	`}`
`57`		`- // ***DS.snippet.0.end`
`58`	`56`	`}`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ public EG038ControllerResponsiveSigning(DSConfiguration config, Session session,`
`34`	`34`	`}`
`35`	`35`
`36`	`36`	`@Override`
`37`		`- // Step 3 start`
	`37`	`+ //ds-snippet-start:eSign38Step3`
`38`	`38`	`protected Object doWork(WorkArguments args, ModelMap model,`
`39`	`39`	`HttpServletResponse response) throws ApiException, IOException {`
`40`	`40`	`String signerName = args.getSignerName();`
`@@ -84,5 +84,5 @@ protected Object doWork(WorkArguments args, ModelMap model,`
`84`	`84`
`85`	`85`	`return new RedirectView(viewUrl.getUrl());`
`86`	`86`	`}`
`87`		`- // Step 3 end`
	`87`	`+ //ds-snippet-end:eSign38Step3`
`88`	`88`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,9 @@ public static byte[] envelopeGetDoc(`
`12`	`12`	`String envelopeId,`
`13`	`13`	`String documentId`
`14`	`14`	`) throws ApiException {`
	`15`	`+ //ds-snippet-start:eSign7Step3`
`15`	`16`	`return envelopesApi.getDocument(accountId, envelopeId, documentId);`
	`17`	`+ //ds-snippet-end:eSign7Step3`
`16`	`18`	`}`
`17`	`19`
`18`	`20`	`public static String addExtension(String fileName, String extension) {`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@`
`4`	`4`	`import com.docusign.esign.client.ApiException;`
`5`	`5`	`import com.docusign.esign.model.Envelope;`
`6`	`6`
	`7`	`+//ds-snippet-start:eSign4Step2`
`7`	`8`	`public final class EnvelopeInfoService {`
`8`	`9`	`public static Envelope envelopeInfo(`
`9`	`10`	`EnvelopesApi envelopesApi,`
`@@ -13,3 +14,4 @@ public static Envelope envelopeInfo(`
`13`	`14`	`return envelopesApi.getEnvelope(accountId, envelopeId);`
`14`	`15`	`}`
`15`	`16`	`}`
	`17`	`+//ds-snippet-end:eSign4Step2`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ public static EnvelopeSummary idvAuthentication(`
`24`	`24`	`}`
`25`	`25`
`26`	`26`	`public static String retrieveWorkflowId(ApiClient apiClient, String accountId) throws ApiException {`
`27`		`- // Step 3 start`
	`27`	`+ //ds-snippet-start:eSign23Step3`
`28`	`28`	`AccountsApi workflowDetails = new AccountsApi(apiClient);`
`29`	`29`	`AccountIdentityVerificationResponse workflowRes = workflowDetails.getAccountIdentityVerification(accountId);`
`30`	`30`	`List<AccountIdentityVerificationWorkflow> identityVerification = workflowRes.getIdentityVerification();`
`@@ -37,9 +37,10 @@ public static String retrieveWorkflowId(ApiClient apiClient, String accountId) t`
`37`	`37`	`}`
`38`	`38`	`}`
`39`	`39`	`return workflowId;`
`40`		`- // Step 3 end`
	`40`	`+ //ds-snippet-end:eSign23Step3`
`41`	`41`	`}`
`42`	`42`
	`43`	`+ //ds-snippet-start:eSign23Step4`
`43`	`44`	`public static EnvelopeDefinition createEnvelope(`
`44`	`45`	`String signerName,`
`45`	`46`	`String signerEmail,`
`@@ -99,4 +100,5 @@ public static EnvelopeDefinition createEnvelope(`
`99`	`100`	`envelopeDefinition.setDocuments(Collections.singletonList(doc1));`
`100`	`101`	`return envelopeDefinition;`
`101`	`102`	`}`
	`103`	`+ //ds-snippet-end:eSign23Step4`
`102`	`104`	`}`