added dynamic content (#28)

Author: RomanBachaloSigmaSoftware

.env

@@ -16,6 +16,9 @@ DS_PAYMENT_GATEWAY_ID={DS_PAYMENT_GATEWAY_ID}
 DS_PAYMENT_GATEWAY_NAME={DS_PAYMENT_GATEWAY_NAME}
 DS_PAYMENT_GATEWAY_DISPLAY_NAME={DS_PAYMENT_GATEWAY_DISPLAY_NAME}
 
+# The ID of clickwrap with dynamic content properties
+CLICKWRAP_ID={CLICKWRAP_ID}
+
 # private key string - source or path, for instance: /app/id_rsa
 # NOTE: the Python config file parser requires that you
 # add a space at the beginning of the second and

README.MD

@@ -45,6 +45,7 @@ MySure demonstrates the following:
 * **DS_PAYMENT_GATEWAY_ID** - Payment gateway ID (Only Stripe method supported)
 * **DS_PAYMENT_GATEWAY_NAME** - Payment gateway name
 * **DS_PAYMENT_GATEWAY_DISPLAY_NAME** - Payment gateway display name
+* **CLICKWRAP_ID** - The ID of clickwrap with dynamic content properties
 * **DS_PRIVATE_KEY** - Private key string, source or path; for instance: /app/id_rsa
 * **REACT_APP_DS_RETURN_URL** - URL where the back end of the application is located (If you run it locally, use `http://localhost:3000`)
 * **REACT_APP_API_BASE_URL** - URL where the front end of the application is located; will be used by Docusign to redirect back after signing ceremony (If you run it locally, use `http://localhost:5001/api`)
@@ -63,6 +64,8 @@ MySure demonstrates the following:
 5. Update the **.env** file with the integration key and other settings.  
     > **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.
 
+    > **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.
+
 **Using installation scripts**
 
 1. Download or clone this repository to your workstation in a new folder named **sample-app-mysure-python**.

app/api/clickwrap.py

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

app/clickwrap.py

@@ -1,73 +1,17 @@
-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
-
+from app.ds_config import CLICKWRAP_ID
 
 class Clickwrap: # pylint: disable=too-few-public-methods
     @staticmethod
-    def create(args, session):
-        """Creates a clickwrap for an account
-        Parameters:
-            args (dict): Parameters for the clickwrap.
+    def get(args, session):
+        """Gets a clickwrap and account data
         Returns:
-            JSON structure of the created clickwrap.
+            JSON structure of the clickwrap.
         """
-        terms_name = args.get('terms_name')
-        file_name = 'terms-renewal.docx'
         account_id = session.get('account_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
+        clickwrap = {
+            'accountId': account_id,
+            'clickwrapId': CLICKWRAP_ID
         }
 
-        # 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]
+        return clickwrap

app/ds_config.py

@@ -20,3 +20,5 @@
 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')