support custom folders

Author: RomanBachaloSigmaSoftware

app/eSignature/examples/eg045_delete_restore_envelope.py

@@ -24,3 +24,13 @@ def move_envelope(args):
         results = folders_api.move_envelopes(account_id=args["account_id"], folder_id=args["folder_id"], folders_request=folders_request)
         #ds-snippet-end:eSign45Step4
         return results
+
+    @staticmethod
+    def get_folders(args):
+        api_client = create_api_client(base_path=args["base_path"], access_token=args["access_token"])
+        folders_api = FoldersApi(api_client)
+
+        #ds-snippet-start:eSign45Step5
+        results = folders_api.list(account_id=args["account_id"])
+        #ds-snippet-end:eSign45Step5
+        return results

app/eSignature/utils.py

@@ -0,0 +1,10 @@
+def get_folder_id_by_name(folders, folder_name):
+    for folder in folders:
+        if folder.name.lower() == folder_name.lower():
+            return folder.folder_id
+
+        subfolders = folder.folders
+        if subfolders is not None and len(subfolders) > 0:
+            folder_id = get_folder_id_by_name(subfolders, folder_name)
+            if folder_id is not None:
+                return folder_id

app/eSignature/views/eg045_delete_restore_envelope.py

@@ -1,11 +1,12 @@
-""" Example 045: Delete and Restore an Envelope """
+""" Example 045: Delete and undelete an Envelope """
 
 from os import path
 
 from docusign_esign.client.api_exception import ApiException
 from flask import render_template, session, Blueprint, request, redirect
 
 from ..examples.eg045_delete_restore_envelope import Eg045DeleteRestoreEnvelopeController
+from ..utils import get_folder_id_by_name
 from ...docusign import authenticate, ensure_manifest, get_example_by_number
 from ...ds_config import DS_CONFIG
 from ...error_handlers import process_error
@@ -54,7 +55,7 @@ def delete_envelope():
     return render_template(
         "example_done.html",
         title=example["ExampleName"],
-        message=additional_page_data["ResultsPageText"],
+        message=additional_page_data["ResultsPageText"].format(args["envelope_id"]),
         redirect_url=restore_endpoint
     )
 
@@ -69,26 +70,43 @@ def restore_envelope():
     """
 
     # 1. Get required arguments
+    folder_name = pattern.sub("", request.form.get("folder_name"))
     args = {
         "account_id": session["ds_account_id"],
         "base_path": session["ds_base_path"],
         "access_token": session["ds_access_token"],
         "envelope_id": pattern.sub("", session.get("envelope_id")),
-        "folder_id": restore_folder_id,
         "from_folder_id": delete_folder_id
     }
+
+    example = get_example_by_number(session["manifest"], example_number, api)
     try:
         # 2. Call the worker method
+        folders = Eg045DeleteRestoreEnvelopeController.get_folders(args)
+        args["folder_id"] = get_folder_id_by_name(folders.folders, folder_name)
+
+        if args["folder_id"] is None:
+            additional_page_data = next(
+                (p for p in example["AdditionalPage"] if p["Name"] == "folder_does_not_exist"), 
+                None
+            )
+
+            return render_template(
+                "example_done.html",
+                title=example["ExampleName"],
+                message=additional_page_data["ResultsPageText"].format(folder_name),
+                redirect_url=restore_endpoint
+            )
+
         Eg045DeleteRestoreEnvelopeController.move_envelope(args)
     except ApiException as err:
         return process_error(err)
 
     # 3. Render success response with envelopeId
-    example = get_example_by_number(session["manifest"], example_number, api)
     return render_template(
         "example_done.html",
         title=example["ExampleName"],
-        message=example["ResultsPageText"]
+        message=example["ResultsPageText"].format(session.get("envelope_id", ""), args["folder_id"], folder_name)
     )
 
 @eg045.route(f"/{eg}", methods=["GET"])

app/templates/eSignature/eg045_restore_envelope.html

@@ -5,13 +5,19 @@ <h4>{{ title }}</h4>
 <p>{{ session["manifest"]["SupportingTexts"]["HelpingTexts"]["EnvelopeWillBeRestored"].format(envelope_id) | safe }}</p>
 
 {%  set form_index = 0 %}
-{%  set envelope_id_index = 0 %}
+{%  set folder_name_index = 1 %}
 
 <form class="eg" action="" method="post" data-busy="form">
-    {% if 'FormName' in example['Forms'][recipient_form_index] %}
-        <p>{{ example['Forms'][recipient_form_index]['FormName'] | safe }}</p>
+    {% if 'FormName' in example['Forms'][form_index] %}
+      <p>{{ example['Forms'][form_index]['FormName'] | safe }}</p>
     {% endif %}
 
+    <div class="form-group">
+      <label for="folder_name">{{ example['Forms'][form_index]['Inputs'][folder_name_index]['InputName'] }}</label>
+      <input type="text" class="form-control" id="folder_name" name="folder_name"
+             placeholder="{{ example['Forms'][form_index]['Inputs'][folder_name_index]['InputPlaceholder'] }}" required/>
+    </div>
+
     <input type="hidden" name="csrf_token" value="{{ csrf_token() }}"/>
     {% include 'submit_button.html' %}
   </form>