Merge pull request #60 from eversign/issue#59-extending-signer-object

issue#59 Extending signer object with various fields

Author: alexeriksen

lib/Signer.js

@@ -91,14 +91,49 @@ function Signer(newSigner = {}) {
      */
     status: undefined,
 
-
     /**
      * the embedded/iframe signing url
      *
      * @var {Date} embeddedSigningUrl
      * @type {Date}
      */
     embeddedSigningUrl: undefined,
+
+    /**
+     * This parameter is only applicable if embedded_signing_enabled is set to 1.
+     * When this parameter is set, embedded document signers will be notified by email.
+     *
+     * @type {Boolean}
+     */
+    deliverEmail: undefined,
+
+    /**
+     * This parameter is used to specify if signer authentication by SMS is enabled.
+     *
+     * @type {Boolean}
+     */
+    signerAuthenticationSmsEnabled: undefined,
+
+    /**
+     * If signer authentication by SMS is enabled, this parameter is used to specify the phone number to which SMS validation will be delivered. ITU call prefix can start both with 00 or + sign.
+     *
+     * @type {String}
+     */
+    signerAuthenticationPhoneNumber: undefined,
+
+    /**
+     * This parameter can be used to specify a custom message (upon document delivery) for the current signer. Please note that for the current signer the general document message will be overriden by this parameter. 
+     *
+     * @type {String}
+     */
+    message: undefined,
+
+    /**
+     * This parameter is used to specify the language in which signing notifications (emails), the document status page and the signature process will appear for this signer. 
+     *
+     * @type {String}
+     */
+    language: undefined,
   };
 
   Object.assign(signer, newSigner);
@@ -143,6 +178,31 @@ function Signer(newSigner = {}) {
     return signer.status;
   };
 
+  this.getEmbeddedSigningUrl = function () {
+    return signer.embeddedSigningUrl;
+  };
+
+  this.getDeliverEmail = function () {
+    return signer.deliverEmail;
+  }
+
+  this.getSignerAuthenticationSmsEnabled = function () {
+    return signer.signerAuthenticationSmsEnabled;
+  }
+
+  this.getSignerAuthenticationPhoneNumber = function () {
+    return signer.signerAuthenticationPhoneNumber;
+  }
+
+  this.getMessage = function () {
+    return signer.message;
+  }
+
+  this.getLanguage = function () {
+    return signer.language;
+  }
+
+
   this.setId = function (newId) {
     signer.id = newId;
   };
@@ -215,14 +275,34 @@ function Signer(newSigner = {}) {
     signer.required = newRequired;
   }
 
+  this.setEmbeddedSigningUrl = function (newEmbeddedSigningUrl) {
+    signer.embeddedSigningUrl = newEmbeddedSigningUrl;
+  }
+
+  this.setDeliverEmail = function (newDeliverEmail) {
+    signer.deliverEmail = newDeliverEmail;
+  }
+
+  this.setSignerAuthenticationSmsEnabled = function (newSignerAuthenticationSmsEnabled) {
+    signer.signerAuthenticationSmsEnabled = newSignerAuthenticationSmsEnabled;
+  }
+
+  this.setSignerAuthenticationPhoneNumber = function (newSignerAuthenticationPhoneNumber) {
+    signer.signerAuthenticationPhoneNumber = newSignerAuthenticationPhoneNumber;
+  }
+
+  this.setMessage = function (newMessage) {
+    signer.message = newMessage;
+  }
+
+  this.setLanguage = function (newLanguage) {
+    signer.language = newLanguage;
+  }
+
   this.toObject = function () {
     return Object.assign(this, signer);
   };
 
-  this.getEmbeddedSigningUrl = function () {
-    return signer.embeddedSigningUrl;
-  };
-
 }
 
 module.exports = Signer;