add Admin 4 step 4 and update text (#37)

* add Admin 4 step 4 and update text

Author: karissarjacobsen

README.md

@@ -2,7 +2,7 @@
 
 ### GitHub repo: [code-examples-node](./README.md)
 
-This GitHub repo includes code examples for the DocuSign eSignature REST API, Rooms API, Click API, and Monitor API. To switch between API code examples, modify the `examplesApi` setting in the appsettings.json file. Change the value of either `isESignatureApi`, `isRoomsApi`, `isClickApi`, or `isMonitorApi` to `true` to use the corresponding API. Set only one API type to `true` and set the remaining to `false`.
+This GitHub repo includes code examples for the DocuSign Admin API, Click API, eSignature REST API, Monitor API, and Rooms API. To switch between API code examples, modify the `examplesApi` setting in the appsettings.json file. Set only one API type to `true` and set the remaining to `false`.
 
 If none of the API types are set to `true`, the DocuSign eSignature REST API code examples will be shown. If multiple API types are set to `true`, only the first will be shown.
 
@@ -43,11 +43,11 @@ For information about the scopes used for obtaining authorization to use the Mon
 For a list of code examples that use the Monitor API, select the Node.js tab under [Examples and languages](https://developers.docusign.com/docs/monitor-api/how-to/code-launchers/#examples-and-languages) on the DocuSign Developer Center.
 
 ## Admin API
-**Note:** To use the Admin API, you must [create an organization](https://support.docusign.com/en/guides/org-admin-guide-create-org) in your DocuSign account. Also, to run the DocuSign CLM code example, [CLM must be enabled for your organization](https://support.docusign.com/en/articles/DocuSign-and-SpringCM).
+**Note:** To use the Admin API, you must [create an organization](https://support.docusign.com/en/guides/org-admin-guide-create-org) in your DocuSign developer account. Also, to run the DocuSign CLM code example, [CLM must be enabled for your organization](https://support.docusign.com/en/articles/DocuSign-and-SpringCM).
 
-For information about the scopes used for obtaining authorization to use the Admin API, see the [scopes section](https://developers.docusign.com/docs/admin-api/admin101/auth/).
+For more information about the scopes used for obtaining authorization to use the Admin API, see the [scopes section](https://developers.docusign.com/docs/admin-api/admin101/auth/).
 
-For a list of code examples that use the Monitor API, select the Node.js tab under [Examples and languages](hhttps://developers.docusign.com/docs/admin-api/how-to/code-launchers/#examples-and-languages) on the DocuSign Developer Center.
+For a list of code examples that use the Admin API, select the Node.js tab under [Examples and languages](https://developers.docusign.com/docs/admin-api/how-to/code-launchers/#examples-and-languages) on the DocuSign Developer Center.
 
 ## Installation
 

index.js

@@ -21,20 +21,20 @@ const csrf = require('csurf'); // https://www.npmjs.com/package/csurf
 
 const eg001 = require('./eg001EmbeddedSigning');
 
-const { 
-  eg002, eg003, eg004, eg005, eg006, eg007, eg008, 
+const {
+  eg002, eg003, eg004, eg005, eg006, eg007, eg008,
   eg009, eg010, eg011, eg012, eg013, eg014, eg015,
   eg016, eg017, eg018, eg019, eg020, eg021, eg022,
   eg023, eg024, eg025, eg026, eg027, eg028, eg029,
   eg030, eg031, eg032, eg033, eg034, eg035,
 } = require("./lib/eSignature/controllers");
 
-const { 
+const {
   eg001click, eg002click, eg003click,
   eg004click, eg005click,
 } = require("./lib/click/controllers");
 
-const { 
+const {
   eg001rooms, eg002rooms, eg003rooms,
   eg004rooms, eg005rooms, eg006rooms,
   eg007rooms, eg008rooms, eg009rooms,
@@ -143,6 +143,7 @@ if (dsConfig.examplesApi.isRoomsApi) {
     .post('/eg003', eg003admin.createController)
     .get('/eg004', eg004admin.getController)
     .post('/eg004', eg004admin.createController)
+    .get('/eg004status', eg004admin.checkStatus)
     .get('/eg005', eg005admin.getController)
     .post('/eg005', eg005admin.createController)
 } else {

lib/admin/controllers/eg001CreateUser.js

@@ -64,7 +64,7 @@ eg001CreateUser.createController = async(req, res) => {
     res.render('pages/example_done', {
       title: "Create a new active eSignature user",
       h1: "Create a new active eSignature user",
-      message: `Results from Users::createUser method:`,
+      message: "Results from eSignUserManagement:createUser method:",
       json: JSON.stringify(results)
     });
   }
@@ -91,14 +91,16 @@ eg001CreateUser.getController = async (req, res) => {
       };
 
       const { profiles, groups } = await getPermissionProfilesAndGroups(args);
+
+      sourceFile = (path.basename(__filename))[5].toLowerCase() + (path.basename(__filename)).substr(6);
       res.render('pages/admin-examples/eg001CreateUser', {
         eg: eg,
         csrfToken: req.csrfToken(),
         title: "Creating a new user",
         permissionProfiles: profiles.permissionProfiles,
         groups: groups.groups,
-        sourceFile: path.basename(__filename),
-        sourceUrl: dsConfig.githubExampleUrl + "admin/" + path.basename(__filename),
+        sourceFile: sourceFile,
+        sourceUrl: dsConfig.githubExampleUrl + "admin/examples/" + sourceFile,
         documentation: dsConfig.documentation + eg,
         showDoc: dsConfig.documentation
       });

lib/admin/controllers/eg002CreateCLMESignUser.js

@@ -92,6 +92,7 @@ eg002CreateCLMESignUser.getController = async (req, res) => {
       let productPermissionProfiles = await getProductPermissionProfiles(args);
       let dsGroups = await getDSAdminGroups(args);
 
+      sourceFile = (path.basename(__filename))[5].toLowerCase() + (path.basename(__filename)).substr(6);
       res.render("pages/admin-examples/eg002CreateCLMESignUser", {
         eg: eg, csrfToken: req.csrfToken(),
         title: "Create active user for CLM and eSignature",
@@ -100,8 +101,8 @@ eg002CreateCLMESignUser.getController = async (req, res) => {
         dsGroups,
         clmProductId: productPermissionProfiles.clmProductId,
         eSignProductId: productPermissionProfiles.eSignProductId,
-        sourceFile: path.basename(__filename),
-        sourceUrl: dsConfig.githubExampleUrl + path.basename(__filename),
+        sourceFile: sourceFile,
+        sourceUrl: dsConfig.githubExampleUrl + 'admin/examples/' + sourceFile,
         documentation: dsConfig.documentation + eg,
         showDoc: dsConfig.documentation
       });

lib/admin/controllers/eg003BulkExportUserData.js

@@ -57,7 +57,7 @@ eg003BulkExportUserData.createController = async(req, res) => {
     res.render('pages/example_done', {
       title: "Bulk-export user data",
       h1: "Bulk-export user data",
-      message: `Results from UserExport::getUserListExport method: `,
+      message: `User data exported to ${args.filePath}. </br> Results from UserExport:getUserListExport method:`,
       json: JSON.stringify(results)
     });
   }
@@ -76,12 +76,13 @@ eg003BulkExportUserData.getController = async (req, res) => {
     try {
       await getOrganizationId(req);
 
+      sourceFile = (path.basename(__filename))[5].toLowerCase() + (path.basename(__filename)).substr(6);
       res.render('pages/admin-examples/eg003BulkExportUserData', {
         eg: eg,
         csrfToken: req.csrfToken(),
         title: "Create bulk-export user data request",
-        sourceFile: path.basename(__filename),
-        sourceUrl: dsConfig.githubExampleUrl + "admin/" + path.basename(__filename),
+        sourceFile: sourceFile,
+        sourceUrl: dsConfig.githubExampleUrl + "admin/examples/" + sourceFile,
         documentation: dsConfig.documentation + eg,
         showDoc: dsConfig.documentation
       });

lib/admin/controllers/eg004ImportUser.js

@@ -4,7 +4,7 @@
  * @author DocuSign
  */
 const path = require('path');
-const { createBulkImportRequest } = require('../examples/importUser');
+const { createBulkImportRequest, checkStatus } = require('../examples/importUser');
 const dsConfig = require('../../../config/index.js').config;
 const { getOrganizationId } = require("../getOrganizationId.js");
 
@@ -43,7 +43,9 @@ eg004ImportUser.createController = async(req, res) => {
   let results = null;
 
   try {
-     results = await createBulkImportRequest(args)
+     results = await createBulkImportRequest(args);
+     req.session.importId = results.id;
+     console.log(req.session.importId);
   } catch (error) {
     // we can pull the DocuSign error code and message from the response body
     const errorBody = error && error.response && error.response.body;
@@ -58,12 +60,63 @@ eg004ImportUser.createController = async(req, res) => {
     res.render('pages/example_done', {
       title: "Add users via bulk import",
       h1: "Add users via bulk import",
+      checkStatus: true,
       message: `Results from UserImport:addBulkUserImport method:`,
       json: JSON.stringify(results)
     });
   }
 }
 
+/**
+ * Add user via bulk import
+ * @param {object} req Request obj
+ * @param {object} res Response obj
+ */
+ eg004ImportUser.checkStatus = async(req, res) => {
+  // Step 1. Check the token
+  // At this point we should have a good token. But we
+  // double-check here to enable a better UX to the user.
+  const tokenOK = req.dsAuth.checkToken(minimumBufferMin);
+  if (!tokenOK) {
+    req.flash('info', 'Sorry, you need to re-authenticate.');
+    // Save the current operation so it will be resumed after authentication
+    req.dsAuth.setEg(req, eg);
+    res.redirect(mustAuthenticate);
+  }
+
+  const args = {
+    accessToken: req.user.accessToken,
+    accountId: req.session.accountId,
+    importId: req.session.importId,
+    organizationId: req.session.organizationId,
+    basePath: dsConfig.adminAPIUrl
+  };
+
+  let results = null;
+
+  try {
+     results = await checkStatus(args)
+  } catch (error) {
+    // we can pull the DocuSign error code and message from the response body
+    const errorBody = error && error.response && error.response.body;
+    const errorCode = errorBody && errorBody.errorCode;
+    const errorMessage = errorBody && errorBody.message;
+
+    // In production, may want to provide customized error messages and
+    // remediation advice to the user.
+    res.render('pages/error', { err: error, errorCode, errorMessage });
+  }
+  if (results) {
+    res.render('pages/admin-examples/eg004CheckStatus', {
+      title: "Add users via bulk import",
+      h1: "Add users via bulk import",
+      status: results.status,
+      message: "Results from UserImport:getBulkUserImportRequest method:",
+      json: JSON.stringify(results)
+    });
+  }
+}
+
 /**
  * Form page for this application
  */
@@ -77,12 +130,13 @@ eg004ImportUser.getController = async (req, res) => {
     try {
       await getOrganizationId(req);
 
+      sourceFile = (path.basename(__filename))[5].toLowerCase() + (path.basename(__filename)).substr(6);
       res.render('pages/admin-examples/eg004ImportUser', {
         eg: eg,
         csrfToken: req.csrfToken(),
         title: "Add user via bulk import",
-        sourceFile: path.basename(__filename),
-        sourceUrl: dsConfig.githubExampleUrl + "admin/" + path.basename(__filename),
+        sourceFile: sourceFile,
+        sourceUrl: dsConfig.githubExampleUrl + "admin/examples/" + sourceFile,
         documentation: dsConfig.documentation + eg,
         showDoc: dsConfig.documentation
       });

lib/admin/controllers/eg005AuditUsers.js

@@ -45,7 +45,7 @@ eg005AuditUsers.createController = async (req, res) => {
     res.render("pages/example_done", {
       title: "Audit users",
       h1: "Audit users",
-      message: "Results from Users::getUserProfiles method:",
+      message: "Results from eSignUserManagement:getUserProfiles method:",
       json: JSON.stringify(results).replace(/'/g, '')
     });
   }
@@ -71,11 +71,12 @@ eg005AuditUsers.getController = async (req, res) => {
   let tokenOK = req.dsAuth.checkToken();
   if (tokenOK) {
     try {
+      sourceFile = (path.basename(__filename))[5].toLowerCase() + (path.basename(__filename)).substr(6);
       res.render("pages/admin-examples/eg005AuditUsers", {
         eg: eg, csrfToken: req.csrfToken(),
         title: "Audit Users",
-        sourceFile: path.basename(__filename),
-        sourceUrl: dsConfig.githubExampleUrl + path.basename(__filename),
+        sourceFile: sourceFile,
+        sourceUrl: dsConfig.githubExampleUrl + 'admin/examples/' + sourceFile,
         documentation: dsConfig.documentation + eg,
         showDoc: dsConfig.documentation
       });

lib/admin/examples/importUser.js

@@ -21,4 +21,16 @@ const createBulkImportRequest = async(args) => {
   // Step 3 end
 }
 
-module.exports = { createBulkImportRequest };
+const checkStatus = async(args) => {
+  const apiClient = new docusign.ApiClient();
+  apiClient.setBasePath(args.basePath);
+  apiClient.addDefaultHeader("Authorization", "Bearer " + args.accessToken);
+
+  const bulkImportsApi = new docusign.BulkImportsApi(apiClient);
+
+  // Step 4 start
+  return await bulkImportsApi.getBulkUserImportRequest(args.organizationId, args.importId);
+  // Step 4 end
+}
+
+module.exports = { createBulkImportRequest, checkStatus};

lib/click/controllers/eg001CreateClickwrap.js

@@ -81,11 +81,12 @@ eg001CreateClickwrap.getController = async (req, res) => {
     // since they have not yet entered any information into the form
     const tokenOK = req.dsAuth.checkToken();
     if (tokenOK){
+        sourceFile = (path.basename(__filename))[5].toLowerCase() + (path.basename(__filename)).substr(6);
         res.render("pages/click-examples/eg001CreateClickwrap", {
             eg: eg, csrfToken: req.csrfToken(),
             title: "Creating a new clickwrap",
-            sourceFile: path.basename(__filename),
-            sourceUrl: dsConfig.githubExampleUrl + path.basename(__filename),
+            sourceFile: sourceFile,
+            sourceUrl: dsConfig.githubExampleUrl + 'click/examples/' + sourceFile,
             documentation: dsConfig.documentation + eg,
             showDoc: dsConfig.documentation
         });

lib/click/controllers/eg002ActivateClickwrap.js

@@ -77,12 +77,13 @@ eg002ActivateClickwrap.getController = async (req, res) => {
     // since they have not yet entered any information into the form
     const tokenOK = req.dsAuth.checkToken();
     if (tokenOK){
+        sourceFile = (path.basename(__filename))[5].toLowerCase() + (path.basename(__filename)).substr(6);
         res.render("pages/click-examples/eg002ActivateClickwrap", {
             eg: eg, csrfToken: req.csrfToken(),
             title: "Activating a new clickwrap",
             clickwrapOk: req.session.hasOwnProperty("clickwrapId"),
-            sourceFile: path.basename(__filename),
-            sourceUrl: dsConfig.githubExampleUrl + path.basename(__filename),
+            sourceFile: sourceFile,
+            sourceUrl: dsConfig.githubExampleUrl + 'click/examples/' + sourceFile,
             documentation: dsConfig.documentation + eg,
             showDoc: dsConfig.documentation
         });