Merge branch 'master' of https://github.com/docusign/code-examples-python

Author: InbarGazit

.gitignore

@@ -123,3 +123,6 @@ private.key
 # Current flask session
 
 flask_session/
+
+# Workflow ID file
+WORKFLOW_ID.txt

Dockerfile

@@ -0,0 +1,19 @@
+# start by pulling the python image
+FROM python:3.11.9-slim-bullseye
+
+# copy the requirements file into the image
+COPY ./requirements.txt /app/requirements.txt
+
+# switch working directory
+WORKDIR /app
+
+# install the dependencies and packages in the requirements file
+RUN pip install -r requirements.txt
+
+# copy every content from the local file to the image
+COPY . /app
+
+# configure the container to run in an executed manner
+ENTRYPOINT [ "python" ]
+
+CMD ["run.py", "--docker"]

PAYMENTS_INSTALLATION.md

@@ -11,7 +11,7 @@ DocuSign offers built-in connections to multiple payment gateways. The payments
 
    ![Skipping the Stripe account form](docs/stripe_skip_account_form_link.png) 
 
-   An enabled Stripe payment gateway is now associated with your DocuSign developer account and is shown under **Payment Gateway**.
+   An enabled Stripe payment gateway is now associated with your Docusign developer account and is shown under **Payment Gateway**.
 
 1. Save the **Gateway Account ID** GUID to the code example launcher configuration file.
 

app/__init__.py

@@ -12,6 +12,7 @@
 from .monitor import views as monitor_views
 from .admin import views as admin_views
 from .connect import views as connect_views
+from .maestro import views as maestro_views
 from .webforms import views as webforms_views
 from .views import core
 
@@ -114,6 +115,10 @@
 
 app.register_blueprint(connect_views.cneg001)
 
+app.register_blueprint(maestro_views.mseg001)
+app.register_blueprint(maestro_views.mseg002)
+app.register_blueprint(maestro_views.mseg003)
+
 app.register_blueprint(webforms_views.weg001)
 
 if "DYNO" in os.environ:  # On Heroku?

app/consts.py

@@ -29,6 +29,8 @@
 # Base uri for callback function
 base_uri_suffix = "/restapi"
 
+# Workflow name
+workflow_name = "Example workflow - send invite to signer"
 
 # Default languages for brand
 languages = {
@@ -114,5 +116,6 @@
     "ROOMS": "Rooms",
     "ADMIN": "Admin",
     "CONNECT": "Connect",
+    "MAESTRO": "Maestro",
     "WEBFORMS": "WebForms"
 }

app/docusign/ds_client.py

@@ -33,6 +33,10 @@
     "asset_group_account_read", "asset_group_account_clone_write", "asset_group_account_clone_read"
 ]
 
+MAESTRO_SCOPES = [
+    "signature", "aow_manage"
+]
+
 WEBFORMS_SCOPES = [
     "signature", "webforms_read", "webforms_instance_read", "webforms_instance_write"
 ]
@@ -61,6 +65,8 @@ def _auth_code_grant(cls, api):
             use_scopes.extend(CLICK_SCOPES)
         elif api == "Admin":
             use_scopes.extend(ADMIN_SCOPES)
+        elif api == "Maestro":
+            use_scopes.extend(MAESTRO_SCOPES)
         elif api == "WebForms":
             use_scopes.extend(WEBFORMS_SCOPES)
         else:
@@ -99,6 +105,8 @@ def _jwt_auth(cls, api):
             use_scopes.extend(CLICK_SCOPES)
         elif api == "Admin":
             use_scopes.extend(ADMIN_SCOPES)
+        elif api == "Maestro":
+            use_scopes.extend(MAESTRO_SCOPES)
         elif api == "WebForms":
             use_scopes.extend(WEBFORMS_SCOPES)
         else:

app/docusign/utils.py

@@ -1,7 +1,7 @@
 from datetime import timedelta, datetime
 from functools import wraps
 import requests
-import urllib
+from urllib.parse import urlparse, parse_qs
 import json
 import re
 
@@ -148,6 +148,16 @@ def get_user_info(access_token, base_path, oauth_host_name):
     api_client.set_oauth_host_name(oauth_host_name)
     return api_client.get_user_info(access_token)
 
+def get_parameter_value_from_url(url, param_name):
+    parsed_url = urlparse(url)
+    query_params = parse_qs(parsed_url.query)
+
+    # Access the parameter value (returns a list)
+    param_value_list = query_params.get(param_name, [])
+
+    # If the parameter exists, return the first value; otherwise, return None
+    return param_value_list[0] if param_value_list else None
+
 def replace_template_id(file_path, template_id):
     with open(file_path, 'r') as file:
         content = file.read()

app/ds_config_sample.py

@@ -16,6 +16,7 @@
     "rooms_api_client_host": "https://demo.rooms.docusign.com/restapi",
     "monitor_api_client_host": "https://lens-d.docusign.net",
     "admin_api_client_host": "https://api-d.docusign.net/management",
+    "maestro_api_client_host": "https://apps-d.docusign.com/api/maestro",
     "webforms_api_client_host": "https://apps-d.docusign.com/api/webforms/v1.1",
     "allow_silent_authentication": True,  # a user can be silently authenticated if they have an
     # active login session on another tab of the same browser
@@ -28,6 +29,7 @@
     "doc_terms_pdf": "Term_Of_Service.pdf",
     "doc_txt": "Welcome.txt",
     "doc_offer_letter": "Offer_Letter_Demo.docx",
+    "doc_dynamic_table": "Offer_Letter_Dynamic_Table.docx",
     # Payment gateway information is optional
     "gateway_account_id": "{DS_PAYMENT_GATEWAY_ID}",
     "gateway_name": "stripe",

app/eSignature/examples/eg011_embedded_sending.py

@@ -1,8 +1,9 @@
 import base64
 from os import path
 
-from docusign_esign import EnvelopesApi, ReturnUrlRequest, EnvelopesApi, EnvelopeDefinition, \
-    Document, Signer, CarbonCopy, SignHere, Tabs, Recipients
+from docusign_esign import EnvelopesApi, EnvelopesApi, EnvelopeDefinition, \
+    Document, Signer, CarbonCopy, SignHere, Tabs, Recipients, EnvelopeViewRequest, EnvelopeViewSettings, \
+    EnvelopeViewRecipientSettings, EnvelopeViewDocumentSettings, EnvelopeViewTaggerSettings, EnvelopeViewTemplateSettings
 from flask import url_for, session, request
 
 from ...consts import pattern, demo_docs_path
@@ -36,6 +37,7 @@ def get_args():
             "access_token": session["ds_access_token"],
             "envelope_args": envelope_args,
             "ds_return_url": url_for("ds.ds_return", _external=True),
+            "starting_view": starting_view,
         }
         return args
 
@@ -58,23 +60,55 @@ def worker(cls, args, doc_docx_path, doc_pdf_path):
     @classmethod
     #ds-snippet-start:eSign11Step3
     def create_sender_view(cls, args, envelope_id):
-        view_request = ReturnUrlRequest(return_url=args["ds_return_url"])
+        view_request = cls.make_envelope_view_request(args)
         # Exceptions will be caught by the calling function
         api_client = create_api_client(base_path=args["base_path"], access_token=args["access_token"])
 
         envelope_api = EnvelopesApi(api_client)
         sender_view = envelope_api.create_sender_view(
             account_id=args["account_id"],
             envelope_id=envelope_id,
-            return_url_request=view_request
+            envelope_view_request=view_request
         )
 
         # Switch to Recipient and Documents view if requested by the user
         url = sender_view.url
-        if args["starting_view"] == "recipient":
-            url = url.replace("send=1", "send=0")
 
         return url
+    
+    @classmethod
+    def make_envelope_view_request(cls, args):
+        view_request = EnvelopeViewRequest(
+            return_url=args["ds_return_url"],
+            view_access="envelope",
+            settings=EnvelopeViewSettings(
+                starting_screen=args["starting_view"],
+                send_button_action="send",
+                show_back_button="false",
+                back_button_action="previousPage",
+                show_header_actions="false",
+                show_discard_action="false",
+                lock_token="",
+                recipient_settings=EnvelopeViewRecipientSettings(
+                    show_edit_recipients="false",
+                    show_contacts_list="false"
+                ),
+                document_settings=EnvelopeViewDocumentSettings(
+                    show_edit_documents="false",
+                    show_edit_document_visibility="false",
+                    show_edit_pages="false"
+                ),
+                tagger_settings=EnvelopeViewTaggerSettings(
+                    palette_sections="default",
+                    palette_default="custom"
+                ),
+                template_settings=EnvelopeViewTemplateSettings(
+                    show_matching_templates_prompt="true"
+                )
+            )
+        )
+
+        return view_request
     #ds-snippet-end:eSign11Step3
 
     @classmethod

app/eSignature/examples/eg040_document_visibility.py

@@ -82,6 +82,7 @@ def make_envelope(cls, args, doc_docx_path, doc_pdf_path):
         """
         env = EnvelopeDefinition(
             email_subject = "Please sign this document set",
+            enforce_signer_visibility = "true",
         )
 
         doc1_b64 = base64.b64encode(bytes(cls.create_document1(args), "utf-8")).decode("ascii")