Update focused view code example (#176)

* updated focused view example to include phone auth

* trigger the tests

Author: annahileta

src/main/java/com/docusign/controller/eSignature/examples/EG044ControllerFocusedView.java

@@ -40,22 +40,29 @@ protected void onInitModel(WorkArguments args, ModelMap model) throws Exception
     }
 
     @Override
-    protected Object doWork(WorkArguments args, ModelMap model,
-                            HttpServletResponse response) throws Exception {
+    protected Object doWork(
+        WorkArguments args,
+        ModelMap model,
+        HttpServletResponse response
+    ) throws Exception {
         String signerName = args.getSignerName();
         String signerEmail = args.getSignerEmail();
+        String phoneNumber = args.getPhoneNumber();
+        String countryCode = args.getCountryCode();
         String accountId = session.getAccountId();
 
         // Call DocuSign to create the envelope
         ApiClient apiClient = createApiClient(session.getBasePath(), user.getAccessToken());
 
         // Call the method from Examples API to send envelope and generate url for focused view signing
         String[] envelopeIdAndRedirectUrl = new FocusedViewService().sendEnvelopeWithFocusedView(
-                signerEmail,
-                signerName,
-                apiClient,
-                accountId,
-                config.getDsReturnUrl());
+            signerEmail,
+            signerName,
+            phoneNumber,
+            countryCode,
+            apiClient,
+            accountId,
+            config.getDsReturnUrl());
 
         if(envelopeIdAndRedirectUrl.length == 2){
             model.addAttribute(ENVELOPE_ID, envelopeIdAndRedirectUrl[0]);

src/main/java/com/docusign/controller/eSignature/services/FocusedViewService.java

@@ -1,11 +1,15 @@
 package com.docusign.controller.eSignature.services;
 
 import com.docusign.controller.eSignature.examples.EnvelopeHelpers;
+import com.docusign.esign.api.AccountsApi;
 import com.docusign.esign.api.EnvelopesApi;
 import com.docusign.esign.client.ApiClient;
 import com.docusign.esign.client.ApiException;
+import com.docusign.esign.model.AccountIdentityVerificationWorkflow;
 import com.docusign.esign.model.EnvelopeDefinition;
-import com.docusign.esign.model.EnvelopeSummary;
+import com.docusign.esign.model.RecipientIdentityInputOption;
+import com.docusign.esign.model.RecipientIdentityPhoneNumber;
+import com.docusign.esign.model.RecipientIdentityVerification;
 import com.docusign.esign.model.RecipientViewRequest;
 import com.docusign.esign.model.ViewUrl;
 import com.docusign.esign.model.Signer;
@@ -27,27 +31,59 @@ public class FocusedViewService {
 
     private static String SIGNER_CLIENT_ID = "1000";
 
-    private static int ANCHOR_OFFSET_Y = 20;
-
-    private static int ANCHOR_OFFSET_X = 10;
-
     public static String STATE_123 = "?state=123";
 
     public static String AUTHENTICATION_METHOD = "none";
 
     public String[] sendEnvelopeWithFocusedView(
             String signerEmail,
             String signerName,
+            String phoneNumber,
+            String countryCode,
             ApiClient apiClient,
             String accountId,
             String returnUrl) throws ApiException, IOException {
         //ds-snippet-start:eSign44Step3
+        String workflowId = null;
+
+        // Resolve identity verification workflow only when phone auth is requested.
+        if (phoneNumber != null && !phoneNumber.isBlank()) {
+            AccountsApi accountsApi = new AccountsApi(apiClient);
+            var workflowRes = accountsApi.getAccountIdentityVerificationWithHttpInfo(
+                accountId,
+                accountsApi.new GetAccountIdentityVerificationOptions());
+            
+            Map<String, List<String>> headers = workflowRes.getHeaders();
+            java.util.List<String> remaining = headers.get("X-RateLimit-Remaining");
+            List<String> reset = headers.get("X-RateLimit-Reset");
+
+            if (remaining != null & reset != null) {
+                Instant resetInstant = Instant.ofEpochSecond(Long.parseLong(reset.get(0)));
+                System.out.println("API calls remaining: " + remaining);
+                System.out.println("Next Reset: " + resetInstant);
+            }
+
+            List<AccountIdentityVerificationWorkflow> identityVerification =
+                    workflowRes.getData().getIdentityVerification();
+            for (AccountIdentityVerificationWorkflow workflow : identityVerification) {
+                if ("Phone Authentication".equals(workflow.getDefaultName())) {
+                    workflowId = workflow.getWorkflowId();
+                    break;
+                }
+            }
+
+            if (workflowId == null) {
+                throw new ApiException("IDENTITY_WORKFLOW_INVALID_ID");
+            }
+        }
+
         EnvelopeDefinition envelope = makeEnvelope(
                 signerEmail,
                 signerName,
                 SIGNER_CLIENT_ID,
-                ANCHOR_OFFSET_Y,
-                ANCHOR_OFFSET_X,
+                workflowId,
+                phoneNumber,
+                countryCode,
                 DOCUMENT_FILE_NAME,
                 DOCUMENT_NAME);
 
@@ -120,21 +156,37 @@ public EnvelopeDefinition makeEnvelope(
             String signerEmail,
             String signerName,
             String signerClientId,
-            Integer anchorOffsetY,
-            Integer anchorOffsetX,
+            String workflowId,
+            String phoneNumber,
+            String countryCode,
             String documentFileName,
             String documentName) throws IOException {
         String emailSubject = "Please sign this document";
         String recipientId = "1";
-        String anchorString = "/sn1/";
         String docId = "3";
 
         Signer signer = new Signer();
         signer.setEmail(signerEmail);
         signer.setName(signerName);
         signer.clientUserId(signerClientId);
         signer.recipientId(recipientId);
-        signer.setTabs(EnvelopeHelpers.createSingleSignerTab(anchorString, anchorOffsetY, anchorOffsetX));
+
+        if (phoneNumber != null && !phoneNumber.isBlank()) {
+            RecipientIdentityPhoneNumber recipientIdentityPhoneNumber = new RecipientIdentityPhoneNumber();
+            recipientIdentityPhoneNumber.setCountryCode(countryCode);
+            recipientIdentityPhoneNumber.setNumber(phoneNumber);
+
+            RecipientIdentityInputOption inputOption = new RecipientIdentityInputOption();
+            inputOption.setName("phone_number_list");
+            inputOption.setValueType("PhoneNumberList");
+            inputOption.setPhoneNumberList(List.of(recipientIdentityPhoneNumber));
+
+            RecipientIdentityVerification identityVerification = new RecipientIdentityVerification();
+            identityVerification.setWorkflowId(workflowId);
+            identityVerification.setInputOptions(List.of(inputOption));
+
+            signer.setIdentityVerification(identityVerification);
+        }
 
         Recipients recipients = new Recipients();
         recipients.setSigners(Collections.singletonList(signer));

src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/eg044.jsp

@@ -2,7 +2,10 @@
 <jsp:include page="../../../partials/head.jsp"/>
 
 <c:set var="formNumber" value="0" scope="page" />
+<c:set var="phoneFormNumber" value="1" scope="page" />
+<c:set var="countryCodeInputNumber" value="0" scope="page" />
 <c:set var="signerEmailInputNumber" value="0" scope="page" />
+<c:set var="phoneNumberInputNumber" value="1" scope="page" />
 <c:set var="signerNameInputNumber" value="1" scope="page" />
 
 <h4>${example.getExampleName()}</h4>
@@ -49,6 +52,38 @@
                value="${locals.dsConfig.signerName}"
                required>
     </div>
+
+    <br/>
+    <c:if test="${example.getForms().size() gt 1 and not empty example.getForms().get(phoneFormNumber).getFormName()}">
+        ${example.getForms().get(phoneFormNumber).getFormName()}
+    </c:if>
+
+    <c:if test="${example.getForms().size() gt 1 and example.getForms().get(phoneFormNumber).getInputs().size() gt 0}">
+        <div class="form-group">
+            <label for="countryCode">${example.getForms().get(phoneFormNumber).getInputs().get(countryCodeInputNumber).getInputName()}</label>
+            <input type="text"
+                   class="form-control"
+                   id="countryCode"
+                   name="countryCode"
+                   placeholder="${example.getForms().get(phoneFormNumber).getInputs().get(countryCodeInputNumber).getInputPlaceholder()}">
+        </div>
+    </c:if>
+
+    <c:if test="${example.getForms().size() gt 1 and example.getForms().get(1).getInputs().size() gt 1}">
+        <div class="form-group">
+            <label for="phoneNumber">${example.getForms().get(phoneFormNumber).getInputs().get(phoneNumberInputNumber).getInputName()}</label>
+            <input type="text"
+                   class="form-control"
+                   id="phoneNumber"
+                   name="phoneNumber"
+                   aria-describedby="phoneHelp"
+                   placeholder="${example.getForms().get(phoneFormNumber).getInputs().get(phoneNumberInputNumber).getInputPlaceholder()}">
+            <small id="phoneHelp" class="form-text text-muted">
+                Provide a phone number to enable phone authentication for the signer
+            </small>
+        </div>
+    </c:if>
+
     <input type="hidden" name="_csrf" value="${csrfToken}">
     <button type="submit" class="btn btn-docu">${launcherTexts.getSubmitButton()}</button>
 </form>

src/main/webapp/WEB-INF/templates/views/pages/esignature/examples/embed.jsp

@@ -33,8 +33,6 @@
 </body>
 </html>
 
-<p><a href="/">Continue</a></p>
-
 <script src='https://js.docusign.com/bundle.js'></script>
 <script>
     window.DocuSign.loadDocuSign('${integrationKey}')
@@ -47,7 +45,7 @@
                     branding: {
                         primaryButton: {
                             /** Background color of primary button */
-                            backgroundColor: '#333',
+                            backgroundColor: '#50C878',
                             /** Text color of primary button */
                             color: '#fff',
                         }
@@ -56,8 +54,28 @@
                     /** High-level components we allow specific overrides for */
                     signingNavigationButton: {
                         finishText: 'You have finished the document! Hooray!',
-                        position: 'bottom-center'
-                    }
+                        position: 'bottom-center',
+                        shape: 'pill',
+                    },
+
+                    signingAgreeButton: {
+                        finishText: 'I Agree',
+                    },
+
+                    signingDeclineButton: {
+                        show: true,
+                        finishText: 'Decline',
+                        backgroundColor: '#ff0000',
+                        color: '#ffffff',
+                    },
+
+                    downloadModal: {
+                        show: true,
+                    },
+
+                    declineModal: {
+                        show: true,
+                    },
                 }
             });
 
@@ -68,6 +86,7 @@
             signing.on('sessionEnd', (event) => {
                 /** The event here denotes what caused the sessionEnd to trigger, such as signing_complete, ttl_expired etc../ **/
                 console.log('sessionend', event);
+                window.location.href = '/'
             });
 
             signing.mount('#agreement');