get folder id by name

Author: RomanBachaloSigmaSoftware

lib/eSignature/controllers/eg045DeleteRestoreEnvelope.js

@@ -1,14 +1,15 @@
 /**
  * @file
- * Example 045: Delete and Restore an Envelope
+ * Example 045: Delete and Undelete an Envelope
  * @author DocuSign
  */
 
 const path = require('path');
-const { moveEnvelope } = require('../examples/deleteRestoreEnvelope');
+const { moveEnvelope, getFolders } = require('../examples/deleteRestoreEnvelope');
 const { getExampleByNumber } = require('../../manifestService');
 const dsConfig = require('../../../config/index.js').config;
-const { API_TYPES } = require('../../utils.js');
+const { API_TYPES, formatString } = require('../../utils.js');
+const { getFolderIdByName } = require('../getData.js');
 
 const eg045DeleteRestoreEnvelope = exports;
 const exampleNumber = 45;
@@ -65,14 +66,14 @@ eg045DeleteRestoreEnvelope.deleteController = async (req, res) => {
         const additionalPageData = example.AdditionalPage.find(p => p.Name === 'envelope_is_deleted');
         res.render('pages/example_done', {
             title: example.ExampleName,
-            message: additionalPageData.ResultsPageText,
+            message: formatString(additionalPageData.ResultsPageText, req.body.envelopeId),
             redirectUrl: restoreEndpoint,
         });
     }
 };
 
 /**
- * Restore the envelope
+ * Undelete the envelope
  * @param {object} req Request obj
  * @param {object} res Response obj
  */
@@ -96,12 +97,28 @@ eg045DeleteRestoreEnvelope.restoreController = async (req, res) => {
         folderId: restoreFolderId,
         fromFolderId: deleteFolderId,
     };
+    const folderName = req.body.folderName;
+    let folderId = '';
+
+    const example = getExampleByNumber(res.locals.manifest, exampleNumber, api);
 
     // Step 2. Call the worker method
     let results = null;
-
     try {
-        results = await moveEnvelope(args);
+        const folders = await getFolders(args);
+        folderId = getFolderIdByName(folders.folders, folderName);
+
+        if (!folderId) {
+            const additionalPageData = example.AdditionalPage.find(page => page.Name === 'folder_does_not_exist');
+            return res.render('pages/example_done', {
+                title: example.ExampleName,
+                message: formatString(additionalPageData.ResultsPageText, folderName),
+                redirectUrl: restoreEndpoint,
+            });
+
+        }
+
+        results = await moveEnvelope({ ...args, folderId });
     } catch (error) {
         const errorBody = error && error.response && error.response.body;
         // we can pull the DocuSign error code and message from the response body
@@ -112,10 +129,9 @@ eg045DeleteRestoreEnvelope.restoreController = async (req, res) => {
         res.render('pages/error', {err: error, errorCode, errorMessage});
     }
     if (results) {
-        const example = getExampleByNumber(res.locals.manifest, exampleNumber, api);
         res.render('pages/example_done', {
             title: example.ExampleName,
-            message: example.ResultsPageText,
+            message: formatString(example.ResultsPageText, req.session.envelopeId, folderId, folderName),
         });
     }
 };

lib/eSignature/examples/deleteRestoreEnvelope.js

@@ -32,4 +32,18 @@ const moveEnvelope = async (args) => {
   //ds-snippet-end:eSign45Step4
 };
 
-module.exports = { moveEnvelope };
+/**
+ * Retrieves the list of folders
+ */
+const getFolders = async (args) => {
+  const dsApiClient = new docusign.ApiClient();
+  dsApiClient.setBasePath(args.basePath);
+  dsApiClient.addDefaultHeader('Authorization', 'Bearer ' + args.accessToken);
+  const foldersApi = new docusign.FoldersApi(dsApiClient);
+
+  //ds-snippet-start:eSign45Step5
+  return await foldersApi.list(args.accountId);
+  //ds-snippet-end:eSign45Step5
+};
+
+module.exports = { moveEnvelope, getFolders };

lib/eSignature/getData.js

@@ -1,15 +1,27 @@
-const docusign = require('docusign-esign');
-
-async function getUserInfo(accessToken, basePath){
-  const apiClient = new docusign.ApiClient();
-  apiClient.setBasePath(basePath);
-  apiClient.addDefaultHeader('Authorization', 'Bearer ' + accessToken);
-
-  const userInfo = await apiClient.getUserInfo(accessToken);
-  if (!userInfo) {
-    throw new Exception('The user does not have access to account');
-  }
-  return userInfo;
-}
-
-exports.getUserInfo = getUserInfo;
+const docusign = require('docusign-esign');
+
+async function getUserInfo(accessToken, basePath){
+  const apiClient = new docusign.ApiClient();
+  apiClient.setBasePath(basePath);
+  apiClient.addDefaultHeader('Authorization', 'Bearer ' + accessToken);
+
+  const userInfo = await apiClient.getUserInfo(accessToken);
+  if (!userInfo) {
+    throw new Exception('The user does not have access to account');
+  }
+  return userInfo;
+}
+
+function getFolderIdByName(folders, folderName) {
+  for (const folder of folders) {
+    if (folder.name.toLowerCase() === folderName.toLowerCase()) {
+      return folder.folderId;
+    }
+
+    if (folder.folders?.length > 0) {
+      return getFolderIdByName(folder.folders, folderName);
+    }
+  }
+}
+
+module.exports = { getUserInfo, getFolderIdByName };

views/pages/examples/eg045RestoreEnvelope.ejs

@@ -5,6 +5,16 @@
 <p><%- formatString(locals.manifest.SupportingTexts.HelpingTexts.EnvelopeWillBeRestored, envelopeId) %></p>
 
 <form class="eg" action="" method="post" data-busy="form">
+  <% if(example.Forms && example.Forms[0].FormName) { %>
+    <%- example.Forms[0].FormName %>
+  <% } %>
+
+  <div class="form-group">
+    <label for="folderName"><%= example.Forms[0].Inputs[1].InputName %></label>
+    <input type="text" class="form-control" id="folderName" name="folderName"
+          placeholder="<%= example.Forms[0].Inputs[1].InputPlaceholder %>" required>
+  </div>
+
   <input type="hidden" name="_csrf" value="<%- csrfToken %>">
   <%- include("../../partials/submitButton") %>
 </form>