Merge pull request signnow#30 from signnow/SN-2611

Remove document method

Author: Ruslan Tereshchenko

CHANGELOG.md

@@ -9,9 +9,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- Implemented *Remove Document* method
+- Added example how to utilize *Remove Document* method into [README](https://github.com/signnow/SignNowNodeSDK/blob/master/README.md#remove-document)
 - Created [Applet](https://github.com/signnow/SignNowNodeSDK/blob/master/samples/applets/extract-fields.js) for testing *Upload Document with Field Extraction* method
 - Created [Applet](https://github.com/signnow/SignNowNodeSDK/blob/master/samples/applets/view-document.js) for testing *View Document* method
 - Created [Applet](https://github.com/signnow/SignNowNodeSDK/blob/master/samples/applets/download-document.js) for testing *Download Document* method
+- Created [Applet](https://github.com/signnow/SignNowNodeSDK/blob/master/samples/applets/remove-document.js) for testing *Remove Document* method
 
 ## [v1.2.0] - 2019-07-18
 

README.md

@@ -31,6 +31,7 @@ SignNow REST Service Wrapper
       * [Create a One-time Use Download URL](#share-document)
       * [Merge Existing Documents](#merge-documents)
       * [Get Document History](#get-history)
+      * [Remove Document](#remove-document)
     * [Enumerations](#enumerations)
       * [Add Enumeration Field to a Document](#add-enumeration)
       * [Add Enumeration Options to the Field](#enumeration-options)
@@ -324,6 +325,17 @@ api.document.history({
 });
 ```
 
+#### <a name="remove-document"></a>Remove Document
+
+```javascript
+api.document.remove({
+  token: 'your auth token',
+  id: 'document id',
+}, (err, res) => {
+  // handle error or process response data
+});
+```
+
 ### <a name="enumerations"></a>Enumerations
 
 #### <a name="add-enumeration"></a>Add Enumeration Field to a Document

lib/document.js

@@ -666,17 +666,49 @@ class Document {
 
   // get the history of a document
   static history ({ id, token }, callback) {
-    const req = https.request(buildRequestOptions({
-      method: 'GET',
-      path: `/document/${id}/history`,
-      authorization: {
-        type: 'Bearer',
-        token,
-      },
-    }), responseHandler(callback));
-
-    req.on('error', errorHandler(callback));
-    req.end();
+    https
+      .request(buildRequestOptions({
+        method: 'GET',
+        path: `/document/${id}/history`,
+        authorization: {
+          type: 'Bearer',
+          token,
+        },
+      }), responseHandler(callback))
+      .on('error', errorHandler(callback))
+      .end();
+  }
+
+  /**
+   * Remove document payload
+   * @typedef {Object} DocumentRemoveParams
+   * @property {string} id - id of specific document
+   * @property {string} token - your auth token
+   */
+
+  /**
+   * Remove document response data
+   * @typedef {Object} DocumentRemoveResponse
+   * @property {string} status - status of deletion, e.g. 'success'
+   */
+
+  /**
+   * Removes a specified document from folder
+   * @param {DocumentRemoveParams} data - remove document payload
+   * @param {function(err: ApiErrorResponse, res: DocumentRemoveResponse)} [callback] - error first node.js callback
+   */
+  static remove ({ id, token }, callback) {
+    https
+      .request(buildRequestOptions({
+        method: 'DELETE',
+        path: `/document/${id}`,
+        authorization: {
+          type: 'Bearer',
+          token,
+        },
+      }), responseHandler(callback))
+      .on('error', errorHandler(callback))
+      .end();
   }
 
 }

samples/applets/download-document.js

@@ -23,7 +23,7 @@ const api = require('../../lib')({
 });
 
 const { oauth2: { requestToken: getAccessToken } } = api;
-const { document: { download: documentDownload } } = api;
+const { document: { download: downloadDocument } } = api;
 
 getAccessToken({
   username,
@@ -35,16 +35,16 @@ getAccessToken({
     const { access_token: token } = tokenRes;
     const absolutePath = `${pathToSaveFile}/${documentId}.pdf`;
 
-    documentDownload({
+    downloadDocument({
       id: documentId,
       token,
-    }, (downloadError, downloadResponse) => {
-      if (downloadError) {
-        console.log(downloadError);
+    }, (downloadErr, downloadRes) => {
+      if (downloadErr) {
+        console.error(downloadErr);
       } else {
         try {
-          fs.writeFileSync(absolutePath, downloadResponse, { encoding: 'binary' });
-          console.log(`Document has been downloaded. Check your ${absolutePath} directory`);
+          fs.writeFileSync(absolutePath, downloadRes, { encoding: 'binary' });
+          console.log(`Document has been downloaded. Check your ${pathToSaveFile} directory`);
         } catch (err) {
           console.log(err);
         }

samples/applets/remove-document.js

@@ -0,0 +1,45 @@
+/*
+ * to run remove document applet from the project root folder type in your console:
+ * > node samples/applets/download-document <cliend_id> <client_secret> <username> <password> <document_id>
+ * <cliend_id>, <client_secret>, <username>, <password>, <document_id> - are required params
+ */
+
+'use strict';
+
+const [
+  clientId,
+  clientSecret,
+  username,
+  password,
+  documentId,
+] = process.argv.slice(2);
+
+const api = require('../../lib')({
+  credentials: Buffer.from(`${clientId}:${clientSecret}`).toString('base64'),
+  production: false,
+});
+
+const { oauth2: { requestToken: getAccessToken } } = api;
+const { document: { remove: removeDocument } } = api;
+
+getAccessToken({
+  username,
+  password,
+}, (tokenErr, tokenRes) => {
+  if (tokenErr) {
+    console.error(tokenErr);
+  } else {
+    const { access_token: token } = tokenRes;
+
+    removeDocument({
+      id: documentId,
+      token,
+    }, (removeErr, removeRes) => {
+      if (removeErr) {
+        console.error(removeErr);
+      } else {
+        console.log(removeRes);
+      }
+    });
+  }
+});