Merge branch 'master' into feature/maintenance-november-2022

Author: annahileta

README.MD

@@ -7,20 +7,20 @@ MySuresample application written in Python 3.7 (server) and React (client). You
 
 MySure demonstrates the following:
 
-1. Authentication with DocuSign via [JSON Web Token (JWT) Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-jsonwebtoken)
+1. Authentication with DocuSign via [JSON Web Token (JWT) Grant](https://developers.docusign.com/platform/auth/jwt/)
 2. **Submit a claim:** [Source](./app/api/requests.py)   
    This example demonstrates an integration for submitting a claim. It allows you to pass data received from the user to fill in a document. It also adds the ability to attach additional information to the document.  
    * The document, based on an HTML template, is combined with Docusign AutoPlace and attachment features.  
    * The signing ceremony is implemented with embedded signing for a single signer. 
    * The DocuSign signing ceremony is initiated from your website.  
-   * Anchor text ([AutoPlace](https://support.docusign.com/en/guides/AutoPlace-New-DocuSign-Experience)) is used to position the signing fields in the document.  
-   * [Adding attachments](https://support.docusign.com/en/guides/signer-guide-signing-adding-attachments-new) enables users to add additional information to the document.
+   * Anchor text ([AutoPlace](https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place/)) is used to position the signing fields in the document.  
+   * [Adding attachments](https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/documents/attachments/) enables users to add additional information to the document.
 3. **Renew an insurance policy.** [Source](./app/api/clickwrap.py)  
    This example shows how to use the Click API to create a clickwrap programmatically, render it in your UI, and and then submit it. It also tracks the submission event and, just after submission, redirects the user to the final page.  
-   * [More information about Click API](https://developers.docusign.com/click-api) 
+   * [More information about Click API](https://developers.docusign.com/docs/click-api) 
 4. **Purchase a new insurance policy.** [Source](./app/api/requests.py)  
-   The example shows how to [request payment using Docusign](https://www.docusign.com/products/payments). It's implemented using an HTML-based template with [payment tabs](https://developers.docusign.com/esign-rest-api/guides/concepts/tabs/payment). The document also includes different tab types, such as [Formula](https://developers.docusign.com/esign-rest-api/guides/concepts/tabs) and
-   [Checkbox](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/).   
+   The example shows how to [request payment using DocuSign](https://developers.docusign.com/docs/esign-rest-api/how-to/request-a-payment/). It's implemented using an HTML-based template with [payment tabs](https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/payment/). The document also includes different tab types, such as [Formula](https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/calculated-fields/) and
+   [Checkbox](https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/).   
 
    The document contains additional logic to calculate the total amount. At completion, the user is able to pay the calculated amount and get back to the original website.  
 
@@ -65,7 +65,7 @@ MySure demonstrates the following:
     > **Note:** Protect your integration key and client secret. You should make sure that the **.env** file will not be stored in your source code repository.
 6. Navigate to [the admin demo Apps and Keys page](https://admindemo.docusign.com/authenticate?goTo=appsAndKeys), add the Redirect URI http://localhost:3000/callback and then hit save
 
-    > **Note:** You should add a dynamic content properties to your clickwrap by following this [instruction](https://developers.docusign.com/docs/click-api/click101/customize-clickwrap-fields/) before using it in the sample app.
+    > **Note:** You should add a dynamic content properties to your clickwrap by following this [instruction](https://developers.docusign.com/docs/click-api/click101/customize-elastic-template-fields/) before using it in the sample app.
 
 **Using installation scripts**
 

app/api/clickwrap.py

@@ -24,7 +24,7 @@ def insurance_renewal():
     }
 
     try:
-        clickwrap_ = Clickwrap.get(clickwrap_args, session)
+        clickwrap_ = Clickwrap.create(clickwrap_args, session)
     except ApiException as exc:
         return process_error(exc)
     return jsonify(clickwrap=clickwrap_)

app/clickwrap.py

@@ -1,17 +1,73 @@
-from app.ds_config import CLICKWRAP_ID
+import base64
+from os import path
+
+from app.ds_config import (
+    TPL_PATH,
+    CLICKWRAP_BASE_HOST,
+    CLICKWRAP_BASE_URI
+)
+from app.ds_client import DsClient
+
 
 class Clickwrap: # pylint: disable=too-few-public-methods
     @staticmethod
-    def get(args, session):
-        """Gets a clickwrap and account data
+    def create(args, session):
+        """Creates a clickwrap for an account
+        Parameters:
+            args (dict): Parameters for the clickwrap.
         Returns:
-            JSON structure of the clickwrap.
+            JSON structure of the created clickwrap.
         """
+        terms_name = args.get('terms_name')
+        file_name = 'terms-renewal.docx'
         account_id = session.get('account_id')
 
-        clickwrap = {
-            'accountId': account_id,
-            'clickwrapId': CLICKWRAP_ID
+        with open(path.join(TPL_PATH, file_name), 'rb') as binary_file:
+            binary_file_data = binary_file.read()
+            base64_encoded_data = base64.b64encode(binary_file_data)
+            base64_terms = base64_encoded_data.decode('utf-8')
+
+        # Construct clickwrap JSON body
+        body = {
+            'displaySettings': {
+                'consentButtonText': 'I Agree',
+                'displayName': args.get('display_name'),
+                'downloadable': True,
+                'format': 'modal',
+                'hasAccept': True,
+                'mustRead': True,
+                'requireAccept': True,
+                'size': 'medium',
+                'documentDisplay': 'document',
+            },
+            'documents': [
+                {
+                    'documentBase64': base64_terms,
+                    'documentName': terms_name,
+                    'fileExtension': file_name[file_name.rfind('.')+1:],
+                    'order': 0
+                }
+            ],
+            'name': terms_name,
+            'requireReacceptance': True
         }
 
-        return clickwrap
+        # Make a POST call to the clickwraps endpoint to create a clickwrap for an account
+        ds_client = DsClient.get_configured_instance(
+            session.get('access_token'),
+            CLICKWRAP_BASE_HOST
+        )
+
+        uri = f"{CLICKWRAP_BASE_URI}/{account_id}/clickwraps"
+        response = ds_client.call_api(
+            uri, 'POST', body=body, response_type='object'
+        )
+
+        clickwrap_id = response[0].get('clickwrapId')
+
+        # Make a PUT call to the clickwraps endpoint to activate created clickwrap
+        uri = f"{CLICKWRAP_BASE_URI}/{account_id}/clickwraps/{clickwrap_id}/versions/1"
+        response_active = ds_client.call_api(
+            uri, 'PUT', body={'status': 'active'}, response_type='object'
+        )
+        return response_active[0]

app/ds_config.py

@@ -20,5 +20,3 @@
 DS_RETURN_URL = os.environ.get('REACT_APP_DS_RETURN_URL')
 DS_AUTH_SERVER = os.environ.get('DS_AUTH_SERVER')
 DS_DEMO_SERVER = os.environ.get('REACT_APP_DS_DEMO_SERVER')
-
-CLICKWRAP_ID = os.environ.get('CLICKWRAP_ID')

package-lock.json

@@ -1,6 +1,13 @@
 <!DOCTYPE html>
 <html lang="en">
   <head>
+    <!-- Google Tag Manager -->
+    <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
+      new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
+      j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
+      'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
+      })(window,document,'script','dataLayer','GTM-WPK6FN5');</script>
+      <!-- End Google Tag Manager -->
     <meta charset="utf-8" />
     <link rel="icon" href="favicon.ico" />
     <meta name="viewport" content="width=device-width, initial-scale=1" />

public/index.html

@@ -11,9 +11,9 @@
   "DeveloperCenter": "Developer Center",
   "DeveloperCenterLink": "https://developers.docusign.com",
   "APICodeExamples": "DocuSign eSignature API Code Examples",
-  "APICodeExamplesLink": "https://developers.docusign.com/esign-rest-api/code-examples",
+  "APICodeExamplesLink": "https://developers.docusign.com/docs/esign-rest-api/how-to/",
   "ESignatureDocumentation": "DocuSign eSignature API Documentation",
-  "ESignatureDocumentationLink": " https://developers.docusign.com/esign-rest-api/reference",
+  "ESignatureDocumentationLink": " https://developers.docusign.com/docs/esign-rest-api/reference/",
   "DeveloperCommunity": "Developer Community",
   "DeveloperCommunityLink": "http://stackoverflow.com/questions/tagged/docusignapi",
   "AboutDocuSign": "<h3>About DocuSign</h3><ul><li>More than <strong>400 million users</strong> in <strong>188 countries</strong></li><li>More than 300,000 companies</li><li>More than 300,000 new unique users join The DocuSign Global Trust Network every day</li><li>More than 64% of documents are completed within one hour</li>    <li>DocuSign is available in <strong>43 languages</strong></li></ul>",