Added post web query code example (#75)

* added new monitor example

* fixed indents

* default dates

* other text changes

* step comments

* removed extra colon in API method

* Deleted extraneous title, extra colon, extra period

* Removed extra colon

Co-authored-by: Paige Rossi <paige.rossi@docusign.com>
Co-authored-by: meihDS <70775251+meihDS@users.noreply.github.com>

Author: 3 people

index.js

@@ -42,7 +42,9 @@ const {
   eg007rooms, eg008rooms, eg009rooms,
 } = require("./lib/rooms/controllers");
 
-const { eg001monitor } = require("./lib/monitor/controllers/index");
+const {
+  eg001monitor, eg002monitor
+} = require("./lib/monitor/controllers/index");
 
 const {
   eg001admin, eg002admin, eg003admin, eg004admin, eg005admin
@@ -139,6 +141,8 @@ if (examplesApi.examplesApi.isRoomsApi) {
 } else if (examplesApi.examplesApi.isMonitorApi) {
   app.get('/eg001', eg001monitor.getController)
     .post('/eg001', eg001monitor.createController)
+    .get('/eg002', eg002monitor.getController)
+    .post('/eg002', eg002monitor.createController)
 } else if (examplesApi.examplesApi.isAdminApi) {
     app.get('/eg001', eg001admin.getController)
     .post('/eg001', eg001admin.createController)

lib/monitor/controllers/eg001GetMonitoringData.js

@@ -54,7 +54,7 @@ eg001GetMonitoringData.createController = async(req, res) => {
   if (results) {
     res.render('pages/example_done', {
       title: "Monitoring data",
-      h1: "Monitoring data result",
+      h1: "Get monitoring data",
       message: `Results from DataSet:getStream method:`,
       json: JSON.stringify(results).replace(/'/g,'')
     });

lib/monitor/controllers/eg002PostWebQuery.js

@@ -0,0 +1,93 @@
+/**
+ * @file
+ * Example 002: Post web query
+ * @author DocuSign
+ */
+
+const path = require('path');
+const validator = require('validator');
+const { postQuery } = require('../examples/postWebQuery');
+const dsConfig = require('../../../config/index.js').config;
+
+const eg002PostWebQuery = exports;
+const eg = 'eg002'; // This example reference.
+const mustAuthenticate = '/ds/mustAuthenticate';
+const minimumBufferMin = 3;
+
+/**
+ * Create the envelope
+ * @param {object} req Request obj
+ * @param {object} res Response obj
+ */
+ eg002PostWebQuery.createController = async(req, res) => {
+  // Step 1. Check the token
+  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 { body } = req;
+  const args = {
+    accessToken: req.user.accessToken,
+    basePath: dsConfig.monitorApiUrl,
+    accountId: req.session.accountId,
+    version: '2.0',
+    dataset: 'monitor',
+    startDate: validator.escape(body.startDate),
+    endDate: validator.escape(body.endDate),
+  };
+  let results = null;
+
+  try {
+    results = await postQuery(args);
+  } catch (error) {
+    const errorBody = error && error.response && error.response.body;
+    const errorCode = errorBody && errorBody.errorCode;
+    const errorMessage = errorBody && errorBody.message;
+
+    res.render('pages/error', { err: error, errorCode, errorMessage });
+  }
+  if (results) {
+    res.render('pages/example_done', {
+      title: "Query monitoring data with filters",
+      h1: "Query monitoring data with filters",
+      message: `Results from DataSet:postWebQuery method:`,
+      json: JSON.stringify(results).replace(/'/g,'')
+    });
+  }
+}
+
+/**
+ * Form page for this application
+ */
+ eg002PostWebQuery.getController = (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 tokenOK = req.dsAuth.checkToken();
+  const currentDate = new Date();
+  const startDate = new Date();
+  startDate.setDate(startDate.getDate() - 10);
+
+  if (tokenOK) {
+    sourceFile = (path.basename(__filename))[5].toLowerCase() + (path.basename(__filename)).substr(6);
+    res.render('pages/monitor-examples/eg002PostWebQuery', {
+      eg: eg,
+      csrfToken: req.csrfToken(),
+      title: "Query monitoring data with filters",
+      sourceFile: sourceFile,
+      sourceUrl: dsConfig.githubExampleUrl + "monitor/examples/" + sourceFile,
+      documentation: dsConfig.documentation + eg,
+      showDoc: dsConfig.documentation,
+      currentDate: currentDate.toISOString().substring(0,10),
+      startDate: startDate.toISOString().substring(0,10)
+    });
+  } else {
+    // Save the current operation so it will be resumed after authentication
+    req.dsAuth.setEg(req, eg);
+    res.redirect(mustAuthenticate);
+  }
+}

lib/monitor/controllers/index.js

@@ -1 +1,2 @@
 module.exports.eg001monitor = require('./eg001GetMonitoringData');
+module.exports.eg002monitor = require('./eg002PostWebQuery');

lib/monitor/examples/postWebQuery.js

@@ -0,0 +1,56 @@
+/**
+ * @file
+ * Example 002: Post web query
+ * @author DocuSign
+ */
+
+const docusign = require('docusign-monitor');
+
+/**
+ * This function does the work of getting the monitoring data with filters
+ */
+const postQuery = async (args) => {
+
+  // Step 2 start
+  let dsApiClient = new docusign.ApiClient();
+  dsApiClient.setBasePath(args.basePath);
+  dsApiClient.addDefaultHeader("Authorization", "Bearer " + args.accessToken);
+  const datasetApi = new docusign.DataSetApi(dsApiClient);
+  // Step 2 end
+
+  // Step 4 start
+  const queryData = getQuery(args);
+  const result = await datasetApi.postWebQuery(queryData, args.version, args.dataset);
+  // Step 4 end
+
+  return result;
+}
+
+// Step 3 start
+const getQuery = (args) => {
+  return {
+    "filters": [
+      {
+        "FilterName": "Time",
+        "BeginTime": args.startDate,
+        "EndTime": args.endDate
+      },
+      {
+        "FilterName": "Has",
+        "ColumnName": "AccountId",
+        "Value": args.accountId
+      }
+    ],
+    "aggregations": [
+      {
+        "aggregationName": "Raw",
+        "limit": "1",
+        "orderby": [
+          "Timestamp, desc"
+        ]
+      }
+    ]
+  }
+}
+// Step 3 end
+module.exports = { postQuery };