Merge pull request docusign#36 from docusign/bulksendfixes

paigesrossi · web-flow · commit 2f107918a263 · 2021-10-14T10:12:37.000-07:00
Adding step comments to eg031
diff --git a/app/eSignature/examples/eg031_bulk_send/controller.py b/app/eSignature/examples/eg031_bulk_send/controller.py
@@ -58,34 +58,42 @@ def worker(cls, args):
         """
 
         # Construct your API headers
+        # Step 2 start
         api_client = create_api_client(base_path=args["base_path"], access_token=args["access_token"])
+        # Step 2 end
 
         # Submit a bulk list
+        # Step 3-1 start
         bulk_envelopes_api = BulkEnvelopesApi(api_client)
         bulk_sending_list = cls.create_bulk_sending_list(args["signers"])
         bulk_list = bulk_envelopes_api.create_bulk_send_list(
             account_id=args["account_id"],
             bulk_sending_list=bulk_sending_list
         )
         bulk_list_id = bulk_list.list_id
+        # Step 3-1 end
 
         # Create an envelope
+        # Step 4-1 start
         envelope_api = EnvelopesApi(api_client)
         envelope_definition = cls.make_draft_envelope()
         envelope = envelope_api.create_envelope(account_id=args["account_id"], envelope_definition=envelope_definition)
         envelope_id = envelope.envelope_id
+        # Step 4-1 end
 
         # Attach your bulk list id to the envelope
+        # Step 5 start
         text_custom_fields = TextCustomField(name="mailingListId", required="false", show="false", value=bulk_list_id)
         custom_fields = CustomFields(list_custom_fields=[], text_custom_fields=[text_custom_fields])
         envelope_api.create_custom_fields(
             account_id=args["account_id"],
             envelope_id=envelope_id,
             custom_fields=custom_fields
         )
+        # Step 5 end
 
         # Add placeholder tabs
-
+        # Step 6 start
         recipient_sign_here = SignHere(
             anchor_string="/sn1/",
             anchor_units="pixels",
@@ -126,21 +134,28 @@ def worker(cls, args):
             envelope_id=envelope_id,
             recipients=Recipients(signers=[signer, cc])
         )
+        # Step 6 end
 
         # Initiate bulk send
+        # Step 7 start
         bulk_send_request = BulkSendRequest(envelope_or_template_id=envelope_id)
         batch = bulk_envelopes_api.create_bulk_send_request(
             account_id=args["account_id"],
             bulk_send_list_id=bulk_list_id,
             bulk_send_request=bulk_send_request
         )
         batch_id = batch.batch_id
+        # Step 7 end
 
         # Confirm successful batch send
+        # Step 8 start
         response = bulk_envelopes_api.get_bulk_send_batch_status(account_id=args["account_id"], bulk_send_batch_id=batch_id)
+        # Step 8 end
+        print(response)
 
         return response
 
+    # Step 3-2 start
     @classmethod
     def create_bulk_sending_list(cls, args):
         """
@@ -179,7 +194,9 @@ def create_bulk_sending_list(cls, args):
         )
 
         return bulk_sending_list
+    # Step 3-2 end
 
+    # Step 4-2 start
     @classmethod
     def make_draft_envelope(cls):
         """
@@ -245,4 +262,5 @@ def make_draft_envelope(cls):
 
         envelope_definition.recipients = Recipients(signers=[signer], carbon_copies=[cc])
 
-        return envelope_definition
+        return envelope_definition
+    # Step 4-2 end
diff --git a/app/eSignature/examples/eg031_bulk_send/views.py b/app/eSignature/examples/eg031_bulk_send/views.py
@@ -26,15 +26,14 @@ def bulk_send():
     try:
         # 2. Call the worker method for bulk sending
         response = Eg031Controller.worker(args)
-        batch_id = response.batch_id
+        queued = response.queued
         app.logger.info(f"The envelope has been sent to multiple recipients.")
 
         # 3. Render the response
         return render_template("example_done.html",
-                               title="Bulk sending envelopes to multiple recipients",
-                               h1="Bulk sending envelopes to multiple recipients",
-                               message=f"""The envelope has been sent to recipients!<br/>
-                                                Batch id: {batch_id}."""
+                               title="Bulk send envelope was successfully performed!",
+                               h1="Bulk send envelope was successfully performed!",
+                               message=f"""Bulk request queued to {queued} user lists.<br/>"""
                                )
 
     except ApiException as err:
diff --git a/requirements.txt b/requirements.txt
@@ -4,7 +4,7 @@ cffi==1.14.3
 chardet==3.0.4
 Click
 cryptography==3.3.2
-docusign-esign==3.10.0rc1
+docusign-esign==3.12.0
 docusign-rooms==1.1.0
 docusign-monitor==1.0.0
 docusign-click==1.0.0
