update focused view (#183)

Author: RomanBachaloSigmaSoftware

app/eSignature/examples/eg044_focused_view.py

@@ -2,11 +2,11 @@
 from datetime import datetime as dt, timezone
 from os import path
 
-from docusign_esign import EnvelopesApi, RecipientViewRequest, Document, Signer, EnvelopeDefinition, SignHere, Tabs, \
-    Recipients
+from docusign_esign import AccountsApi, EnvelopesApi, RecipientIdentityInputOption, RecipientIdentityPhoneNumber, RecipientViewRequest, Document, Signer, EnvelopeDefinition, \
+    Recipients, RecipientIdentityVerification
 from flask import session, url_for, request
 
-from ...consts import authentication_method, demo_docs_path, pattern, signer_client_id
+from ...consts import demo_docs_path, pattern, signer_client_id
 from ...docusign import create_api_client
 from ...ds_config import DS_CONFIG
 
@@ -20,11 +20,16 @@ def get_args():
         # 1. Parse request arguments
         signer_email = pattern.sub("", request.form.get("signer_email"))
         signer_name = pattern.sub("", request.form.get("signer_name"))
+        phone_number = pattern.sub("", request.form.get("phone_number", ""))
+        country_code = pattern.sub("", request.form.get("country_code", ""))
         envelope_args = {
             "signer_email": signer_email,
             "signer_name": signer_name,
+            "phone_number": phone_number if phone_number else None,
+            "country_code": country_code if country_code else None,
             "signer_client_id": signer_client_id,
             "ds_return_url": url_for("ds.ds_return", _external=True),
+            "ds_ping_url": DS_CONFIG["app_url"] + "/",
         }
         args = {
             "account_id": session["ds_account_id"],
@@ -44,16 +49,41 @@ def worker(cls, args):
         """
         #ds-snippet-start:eSign44Step3
         envelope_args = args["envelope_args"]
-        # 1. Create the envelope request object
-        envelope_definition = cls.make_envelope(envelope_args)
 
         # 2. call Envelopes::create API method
         # Exceptions will be caught by the calling function
         api_client = create_api_client(base_path=args["base_path"], access_token=args["access_token"])
 
+        if envelope_args.get("phone_number"):
+            account_api = AccountsApi(api_client)
+            (workflow_results, status, headers) = account_api.get_account_identity_verification_with_http_info(
+                account_id=args["account_id"]
+            )
+            remaining = headers.get("X-RateLimit-Remaining")
+            reset = headers.get("X-RateLimit-Reset")
+        
+            if remaining is not None and reset is not None:
+                reset_date = dt.fromtimestamp(int(reset), tz=timezone.utc)
+                print(f"API calls remaining: {remaining}")
+                print(f"Next Reset: {reset_date}")
+
+            workflow_id = None
+            if workflow_results.identity_verification:
+                for workflow in workflow_results.identity_verification:
+                    if workflow.default_name == "Phone Authentication":
+                        workflow_id = workflow.workflow_id
+                        break
+
+            if workflow_id is None:
+                raise ValueError("IDENTITY_WORKFLOW_INVALID_ID")
+
+            envelope_args["workflow_id"] = workflow_id
+
+        # Create the envelope request object
+        envelope_definition = cls.make_envelope(envelope_args)
+
         envelope_api = EnvelopesApi(api_client)
         (results, status, headers) = envelope_api.create_envelope_with_http_info(account_id=args["account_id"], envelope_definition=envelope_definition)
-
         remaining = headers.get("X-RateLimit-Remaining")
         reset = headers.get("X-RateLimit-Reset")
 
@@ -68,12 +98,14 @@ def worker(cls, args):
         # 3. Create the Recipient View request object
         #ds-snippet-start:eSign44Step4
         recipient_view_request = RecipientViewRequest(
-            authentication_method=authentication_method,
+            authentication_method="none",
             client_user_id=envelope_args["signer_client_id"],
             recipient_id="1",
-            return_url=envelope_args["ds_return_url"],
+            return_url=envelope_args["ds_return_url"] + "?state=123",
             user_name=envelope_args["signer_name"],
             email=envelope_args["signer_email"],
+            ping_frequency=600,
+            ping_url=envelope_args["ds_ping_url"],
             frame_ancestors=["http://localhost:3000", "https://apps-d.docusign.com"],
             message_origins=["https://apps-d.docusign.com"]
         )
@@ -88,7 +120,6 @@ def worker(cls, args):
             envelope_id=envelope_id,
             recipient_view_request=recipient_view_request
         )
-
         remaining = headers.get("X-RateLimit-Remaining")
         reset = headers.get("X-RateLimit-Reset")
 
@@ -137,18 +168,24 @@ def make_envelope(cls, args):
             client_user_id=args["signer_client_id"]
         )
 
-        # Create a sign_here tab (field on the document)
-        sign_here = SignHere(
-            # DocuSign SignHere field/tab
-            anchor_string="/sn1/",
-            anchor_units="pixels",
-            anchor_y_offset="10",
-            anchor_x_offset="20"
-        )
-
-        # Add the tabs model (including the sign_here tab) to the signer
-        # The Tabs object wants arrays of the different field/tab types
-        signer.tabs = Tabs(sign_here_tabs=[sign_here])
+        if args.get("phone_number"):
+            signer.identity_verification = RecipientIdentityVerification(
+                workflow_id=args["workflow_id"],
+                steps=None,
+                id_check_configuration_name="",
+                input_options = [
+                    RecipientIdentityInputOption(
+                        name="phone_number_list",
+                        value_type="PhoneNumberList",
+                        phone_number_list=[
+                            RecipientIdentityPhoneNumber(
+                                country_code=args["country_code"],
+                                number=args["phone_number"]
+                            )
+                        ]
+                    )
+                ]
+            )
 
         # Next, create the top level envelope definition and populate it.
         envelope_definition = EnvelopeDefinition(

app/templates/eSignature/eg044_embed.html

@@ -16,7 +16,7 @@ <h2>The document has been embedded with focused view.</h2>
         html,
         body {
             padding: 0;
-            margin: 0;
+            margin-top: 15px;
             font: 13px Helvetica, Arial, sans-serif;
         }
 
@@ -32,8 +32,6 @@ <h2>The document has been embedded with focused view.</h2>
 </body>
 </html>
 
-<p><a href="/">Continue</a></p>
-
 <script src='https://js.docusign.com/bundle.js'></script>
 <script>
     window.DocuSign.loadDocuSign('{{ integration_key }}')
@@ -46,7 +44,7 @@ <h2>The document has been embedded with focused view.</h2>
                     branding: {
                         primaryButton: {
                             /** Background color of primary button */
-                            backgroundColor: '#333',
+                            backgroundColor: '#50C878',
                             /** Text color of primary button */
                             color: '#fff',
                         }
@@ -55,8 +53,28 @@ <h2>The document has been embedded with focused view.</h2>
                     /** 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,
+                    },
                 }
             });
 
@@ -67,6 +85,7 @@ <h2>The document has been embedded with focused view.</h2>
             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');

app/templates/eSignature/eg044_focused_view.html

@@ -5,6 +5,9 @@
 {%  set signer_form_index = 0 %}
 {%  set signer_email_index = 0 %}
 {%  set signer_name_index = 1 %}
+{%  set phone_form_index = 1 %}
+{%  set country_code_index = 0 %}
+{%  set phone_number_index = 1 %}
 
 <form class="eg" action="" method="post" data-busy="form">
     {% if 'FormName' in example['Forms'][signer_form_index] %}
@@ -23,6 +26,26 @@
       <input type="text" class="form-control" id="signer_name" placeholder="{{ example['Forms'][signer_form_index]['Inputs'][signer_name_index]['InputPlaceholder'] }}" name="signer_name"
              value="{{ signer_name }}" required>
     </div>
+
+    <br/>
+    {% if example['Forms']|length > phone_form_index and 'FormName' in example['Forms'][phone_form_index] %}
+      <p>{{ example['Forms'][phone_form_index]['FormName'] | safe }}</p>
+    {% endif %}
+
+    {% if example['Forms']|length > phone_form_index %}
+      <div class="form-group">
+        <label for="country_code">{{ example['Forms'][phone_form_index]['Inputs'][country_code_index]['InputName'] }}</label>
+        <input type="text" class="form-control" id="country_code" name="country_code"
+               placeholder="{{ example['Forms'][phone_form_index]['Inputs'][country_code_index]['InputPlaceholder'] }}">
+      </div>
+
+      <div class="form-group">
+        <label for="phone_number">{{ example['Forms'][phone_form_index]['Inputs'][phone_number_index]['InputName'] }}</label>
+        <input type="text" class="form-control" id="phone_number" name="phone_number"
+               aria-describedby="phoneHelp" placeholder="{{ example['Forms'][phone_form_index]['Inputs'][phone_number_index]['InputPlaceholder'] }}">
+        <small id="phoneHelp" class="form-text text-muted">Provide a phone number to enable phone authentication for the signer</small>
+      </div>
+    {% endif %}
     <input type="hidden" name="csrf_token" value="{{ csrf_token() }}"/>
     {% include 'submit_button.html' %}
   </form>