Merge pull request #227 from docusign/feature/workspaces-example-5

Create Upload Request example

Author: nianiB9

index.js

@@ -62,7 +62,10 @@ const { eg004notary } = require('./lib/notary/controllers');
 const { eg001fields } = require('./lib/connectedFields/controllers');
 const { eg001Navigator, eg002Navigator } = require('./lib/navigator/controllers');
 const { eg001maestro, eg002maestro, eg003maestro, eg004maestro } = require('./lib/maestro/controllers');
-const { eg001workspaces, eg002workspaces, eg003workspaces } = require('./lib/workspaces/controllers');
+const {
+  eg001workspaces, eg002workspaces, eg003workspaces,
+  eg005workspaces,
+} = require('./lib/workspaces/controllers');
 
 const PORT = process.env.PORT || 3000;
 const HOST = process.env.HOST || 'localhost';
@@ -325,7 +328,9 @@ app.get('/work001', eg001workspaces.getController)
   .get('/work002', eg002workspaces.getController)
   .post('/work002', eg002workspaces.createController)
   .get('/work003', eg003workspaces.getController)
-  .post('/work003', eg003workspaces.createController);
+  .post('/work003', eg003workspaces.createController)
+  .get('/work005', eg005workspaces.getController)
+  .post('/work005', eg005workspaces.createController);
 
 function dsLoginCB1(req, res, next) { req.dsAuthCodeGrant.oauth_callback1(req, res, next); }
 function dsLoginCB2(req, res, next) { req.dsAuthCodeGrant.oauth_callback2(req, res, next); }

lib/workspaces/controllers/eg001CreateWorkspace.js

@@ -57,6 +57,7 @@ eg001CreateWorkspace.createController = async (req, res) => {
   }
   if (results) {
     req.session.workspaceId = results.workspaceId;
+    req.session.workspaceCreatorId = results.createdByUserId;
 
     const example = getExampleByNumber(res.locals.manifest, exampleNumber, api);
     res.render('pages/example_done', {

lib/workspaces/controllers/eg005CreateUploadRequest.js

@@ -0,0 +1,96 @@
+/**
+ * @file
+ * Example 005: Create a workspace upload request
+ * @author DocuSign
+ */
+
+const path = require('path');
+const { createUploadRequest } = require('../../workspaces/examples/createUploadRequest');
+const validator = require('validator');
+const { getExampleByNumber } = require('../../manifestService');
+const dsConfig = require('../../../config/index').config;
+const { API_TYPES } = require('../../utils');
+
+const eg005CreateUploadRequest = exports;
+const exampleNumber = 5;
+const eg = `work00${exampleNumber}`; // This example reference.
+const api = API_TYPES.WORKSPACES;
+const mustAuthenticate = '/ds/mustAuthenticate';
+const minimumBufferMin = 3;
+/**
+ * Create a workspace upload request
+ * @param {object} req Request obj
+ * @param {object} res Response obj
+ */
+eg005CreateUploadRequest.createController = 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 isTokenOK = req.dsAuth.checkToken(minimumBufferMin);
+  if (!isTokenOK) {
+    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);
+    return res.redirect(mustAuthenticate);
+  }
+
+  // Step 2. Call the worker method
+  const { body } = req;
+  const args = {
+    accessToken: req.user.accessToken,
+    basePath: req.session.basePath,
+    accountId: req.session.accountId,
+    workspaceId: req.session.workspaceId,
+    workspaceCreatorId: req.session.workspaceCreatorId,
+    assigneeEmail: validator.escape(body.assigneeEmail),
+  };
+  let results = null;
+
+  try {
+    results = await createUploadRequest(args);
+  } catch (error) {
+    const errorBody = error?.body || error?.response?.body;
+    // we can pull the DocuSign error code and message from the response body
+    const errorCode = errorBody?.errorCode;
+    const errorMessage = 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) {
+    const example = getExampleByNumber(res.locals.manifest, exampleNumber, api);
+    res.render('pages/example_done', {
+      title: example.ExampleName,
+      message: formatString(example.ResultsPageText, results.uploadRequestId),
+    });
+  }
+};
+
+/**
+ * Form page for this application
+ */
+eg005CreateUploadRequest.getController = async (req, res) => {
+  // Check that the authentication token is ok with a long buffer time.
+  // If needed, now is the best time to ask the user to authenticate
+  // since they have not yet entered any information into the form.
+  const isTokenOK = req.dsAuth.checkToken();
+  if (!isTokenOK) {
+    // Save the current operation so it will be resumed after authentication
+    req.dsAuth.setEg(req, eg);
+    return res.redirect(mustAuthenticate);
+  }
+
+  const example = getExampleByNumber(res.locals.manifest, exampleNumber, api);
+  const sourceFile = (path.basename(__filename))[5].toLowerCase() + (path.basename(__filename)).substr(6);
+  res.render('pages/workspaces-examples/eg005CreateUploadRequest', {
+    eg: eg,
+    csrfToken: req.csrfToken(),
+    workspaceIdOk: !!req.session.workspaceId,
+    workspaceCreatorIdOk: !!req.session.workspaceCreatorId,
+    example: example,
+    sourceFile: sourceFile,
+    sourceUrl: dsConfig.githubExampleUrl + 'workspaces/examples/' + sourceFile,
+    documentation: dsConfig.documentation + eg,
+    showDoc: dsConfig.documentation
+  });
+};

lib/workspaces/controllers/index.js

@@ -1,3 +1,4 @@
 module.exports.eg001workspaces = require('./eg001CreateWorkspace');
 module.exports.eg002workspaces = require('./eg002AddDocumentToWorkspace');
 module.exports.eg003workspaces = require('./eg003SendEnvelopeWithRecipientInfo');
+module.exports.eg005workspaces = require('./eg005CreateUploadRequest');

lib/workspaces/examples/createUploadRequest.js

@@ -0,0 +1,51 @@
+/**
+ * @file
+ * Example 005: Create a workspace upload request
+ * @author DocuSign
+ */
+
+const iam = require('@docusign/iam-sdk');
+const moment = require('moment');
+
+const createUploadRequest = async (args) => {
+  //ds-snippet-start:Workspaces5Step2
+  const client = new iam.IamClient({ accessToken: args.accessToken });
+  //ds-snippet-end:Workspaces5Step2
+
+  const dueDate = moment().add(7, 'days').toDate();
+
+  //ds-snippet-start:Workspaces5Step3
+  // create assignments
+  const assigneeAssignment = {
+    uploadRequestResponsibilityTypeId: 'assignee',
+    firstName: 'Test',
+    lastName: 'User',
+    email: args.assigneeEmail,
+  };
+  const watcherAssignments = {
+    assigneeUserId: args.workspaceCreatorId,
+    uploadRequestResponsibilityTypeId: 'watcher'
+  };
+
+  // create upload request
+  const createWorkspaceUploadRequestBody = {
+    name: `Upload Request example ${dueDate}`,
+    description: 'This is an example upload request created via the workspaces API',
+    dueDate: dueDate,
+    status: 'draft',
+    assignments: [assigneeAssignment, watcherAssignments],
+  };
+  //ds-snippet-end:Workspaces5Step3
+
+  //ds-snippet-start:Workspaces5Step4
+  return await client.workspaces1.workspaceUploadRequest.createWorkspaceUploadRequest(
+    {
+      accountId: args.accountId,
+      workspaceId: args.workspaceId,
+      createWorkspaceUploadRequestBody,
+    }
+  );
+  //ds-snippet-end:Workspaces5Step4
+};
+
+module.exports = { createUploadRequest };

views/pages/workspaces-examples/eg005CreateUploadRequest.ejs

@@ -0,0 +1,34 @@
+<%- include("../../partials/examplesHead") %>
+
+<%- include("../../partials/exampleInfo") %>
+
+<% if (!workspaceIdOk) { %>
+  <%- formatString(example.RedirectsToOtherCodeExamples[0].RedirectText, formatString('href="work00{0}"', example.RedirectsToOtherCodeExamples[0].CodeExampleToRedirectTo)) %>
+  <form class="eg" action="work001" method="get">
+    <%- include("../../partials/continueButton") %>
+  </form>
+<% } else if (!workspaceCreatorIdOk) { %>
+  <%- formatString(example.RedirectsToOtherCodeExamples[1].RedirectText, formatString('href="work00{0}"', example.RedirectsToOtherCodeExamples[1].CodeExampleToRedirectTo)) %>
+  <form class="eg" action="work001" method="get">
+    <%- include("../../partials/continueButton") %>
+  </form>
+<% } else { %>
+  <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="assigneeEmail"><%= example.Forms[0].Inputs[0].InputName %></label>
+      <input type="email" class="form-control" id="assigneeEmail" name="assigneeEmail"
+             aria-describedby="emailHelp" placeholder="<%= example.Forms[0].Inputs[0].InputPlaceholder %>" required
+             value="<%= locals.dsConfig.signerEmail %>">
+      <small id="emailHelp" class="form-text text-muted"><%= locals.manifest.SupportingTexts.HelpingTexts.EmailWontBeShared %></small>
+    </div>
+
+    <input type="hidden" name="_csrf" value="<%- csrfToken %>">
+    <%- include("../../partials/submitButton") %>
+  </form>
+<% } %>
+
+<%- include("../../partials/examplesFoot") %>