docspring 1.3.2 → 1.5.0

package/src/model/{Template1.js → FullTemplate.js}

@@ -16,32 +16,32 @@
 (function(root, factory) {
   if (typeof define === 'function' && define.amd) {
     // AMD. Register as an anonymous module.
-    define(['../ApiClient', '../model/Template1Defaults'], factory);
+    define(['../ApiClient', '../model/FullTemplateDefaults'], factory);
   } else if (typeof module === 'object' && module.exports) {
     // CommonJS-like environments that support module.exports, like Node.
-    module.exports = factory(require('../ApiClient'), require('./Template1Defaults'));
+    module.exports = factory(require('../ApiClient'), require('./FullTemplateDefaults'));
   } else {
     // Browser globals (root is window)
     if (!root.DocSpring) {
       root.DocSpring = {};
     }
-    root.DocSpring.Template1 = factory(root.DocSpring.ApiClient, root.DocSpring.Template1Defaults);
+    root.DocSpring.FullTemplate = factory(root.DocSpring.ApiClient, root.DocSpring.FullTemplateDefaults);
   }
-}(this, function(ApiClient, Template1Defaults) {
+}(this, function(ApiClient, FullTemplateDefaults) {
   'use strict';
 
 
 
 
   /**
-   * The Template1 model module.
-   * @module model/Template1
-   * @version 1.3.2
+   * The FullTemplate model module.
+   * @module model/FullTemplate
+   * @version 1.5.0
    */
 
   /**
-   * Constructs a new <code>Template1</code>.
-   * @alias module:model/Template1
+   * Constructs a new <code>FullTemplate</code>.
+   * @alias module:model/FullTemplate
    * @class
    */
   var exports = function() {
@@ -89,11 +89,11 @@
   };
 
   /**
-   * Constructs a <code>Template1</code> from a plain JavaScript object, optionally creating a new instance.
+   * Constructs a <code>FullTemplate</code> from a plain JavaScript object, optionally creating a new instance.
    * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
    * @param {Object} data The plain JavaScript object bearing properties of interest.
-   * @param {module:model/Template1} obj Optional instance to populate.
-   * @return {module:model/Template1} The populated <code>Template1</code> instance.
+   * @param {module:model/FullTemplate} obj Optional instance to populate.
+   * @return {module:model/FullTemplate} The populated <code>FullTemplate</code> instance.
    */
   exports.constructFromObject = function(data, obj) {
     if (data) {
@@ -187,7 +187,7 @@
         obj['first_template'] = ApiClient.convertToType(data['first_template'], 'Boolean');
       }
       if (data.hasOwnProperty('defaults')) {
-        obj['defaults'] = Template1Defaults.constructFromObject(data['defaults']);
+        obj['defaults'] = FullTemplateDefaults.constructFromObject(data['defaults']);
       }
       if (data.hasOwnProperty('editable_submissions')) {
         obj['editable_submissions'] = ApiClient.convertToType(data['editable_submissions'], 'Boolean');
@@ -225,7 +225,7 @@
    */
   exports.prototype['document_processed'] = undefined;
   /**
-   * @member {module:model/Template1.ExpirationIntervalEnum} expiration_interval
+   * @member {module:model/FullTemplate.ExpirationIntervalEnum} expiration_interval
    */
   exports.prototype['expiration_interval'] = undefined;
   /**
@@ -337,7 +337,7 @@
    */
   exports.prototype['first_template'] = undefined;
   /**
-   * @member {module:model/Template1Defaults} defaults
+   * @member {module:model/FullTemplateDefaults} defaults
    */
   exports.prototype['defaults'] = undefined;
   /**

package/src/model/{Template1Defaults.js → FullTemplateDefaults.js}

@@ -25,7 +25,7 @@
     if (!root.DocSpring) {
       root.DocSpring = {};
     }
-    root.DocSpring.Template1Defaults = factory(root.DocSpring.ApiClient);
+    root.DocSpring.FullTemplateDefaults = factory(root.DocSpring.ApiClient);
   }
 }(this, function(ApiClient) {
   'use strict';
@@ -34,14 +34,14 @@
 
 
   /**
-   * The Template1Defaults model module.
-   * @module model/Template1Defaults
-   * @version 1.3.2
+   * The FullTemplateDefaults model module.
+   * @module model/FullTemplateDefaults
+   * @version 1.5.0
    */
 
   /**
-   * Constructs a new <code>Template1Defaults</code>.
-   * @alias module:model/Template1Defaults
+   * Constructs a new <code>FullTemplateDefaults</code>.
+   * @alias module:model/FullTemplateDefaults
    * @class
    */
   var exports = function() {
@@ -53,11 +53,11 @@
   };
 
   /**
-   * Constructs a <code>Template1Defaults</code> from a plain JavaScript object, optionally creating a new instance.
+   * Constructs a <code>FullTemplateDefaults</code> from a plain JavaScript object, optionally creating a new instance.
    * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
    * @param {Object} data The plain JavaScript object bearing properties of interest.
-   * @param {module:model/Template1Defaults} obj Optional instance to populate.
-   * @return {module:model/Template1Defaults} The populated <code>Template1Defaults</code> instance.
+   * @param {module:model/FullTemplateDefaults} obj Optional instance to populate.
+   * @return {module:model/FullTemplateDefaults} The populated <code>FullTemplateDefaults</code> instance.
    */
   exports.constructFromObject = function(data, obj) {
     if (data) {

package/src/model/HtmlTemplateData.js

@@ -36,7 +36,7 @@
   /**
    * The HtmlTemplateData model module.
    * @module model/HtmlTemplateData
-   * @version 1.3.2
+   * @version 1.5.0
    */
 
   /**

package/src/model/InvalidRequest.js

@@ -36,7 +36,7 @@
   /**
    * The InvalidRequest model module.
    * @module model/InvalidRequest
-   * @version 1.3.2
+   * @version 1.5.0
    */
 
   /**

package/src/model/ListSubmissionsResponse.js

@@ -36,7 +36,7 @@
   /**
    * The ListSubmissionsResponse model module.
    * @module model/ListSubmissionsResponse
-   * @version 1.3.2
+   * @version 1.5.0
    */
 
   /**

package/src/model/MoveFolderData.js

@@ -36,7 +36,7 @@
   /**
    * The MoveFolderData model module.
    * @module model/MoveFolderData
-   * @version 1.3.2
+   * @version 1.5.0
    */
 
   /**

package/src/model/MoveTemplateData.js

@@ -36,7 +36,7 @@
   /**
    * The MoveTemplateData model module.
    * @module model/MoveTemplateData
-   * @version 1.3.2
+   * @version 1.5.0
    */
 
   /**

package/src/model/PendingTemplate.js

@@ -36,7 +36,7 @@
   /**
    * The PendingTemplate model module.
    * @module model/PendingTemplate
-   * @version 1.3.2
+   * @version 1.5.0
    */
 
   /**

package/src/model/RenameFolderData.js

@@ -36,7 +36,7 @@
   /**
    * The RenameFolderData model module.
    * @module model/RenameFolderData
-   * @version 1.3.2
+   * @version 1.5.0
    */
 
   /**

package/src/model/Submission.js

@@ -36,7 +36,7 @@
   /**
    * The Submission model module.
    * @module model/Submission
-   * @version 1.3.2
+   * @version 1.5.0
    */
 
   /**

package/src/model/SubmissionAction.js

@@ -36,7 +36,7 @@
   /**
    * The SubmissionAction model module.
    * @module model/SubmissionAction
-   * @version 1.3.2
+   * @version 1.5.0
    */
 
   /**

package/src/model/SubmissionBatch.js

@@ -36,7 +36,7 @@
   /**
    * The SubmissionBatch model module.
    * @module model/SubmissionBatch
-   * @version 1.3.2
+   * @version 1.5.0
    */
 
   /**

package/src/model/SubmissionBatchData.js

@@ -36,7 +36,7 @@
   /**
    * The SubmissionBatchData model module.
    * @module model/SubmissionBatchData
-   * @version 1.3.2
+   * @version 1.5.0
    */
 
   /**

package/src/model/SubmissionData.js

@@ -36,7 +36,7 @@
   /**
    * The SubmissionData model module.
    * @module model/SubmissionData
-   * @version 1.3.2
+   * @version 1.5.0
    */
 
   /**
@@ -56,6 +56,7 @@
 
 
 
+
   };
 
   /**
@@ -78,6 +79,9 @@
       if (data.hasOwnProperty('data_requests')) {
         obj['data_requests'] = ApiClient.convertToType(data['data_requests'], [CreateSubmissionDataRequestData]);
       }
+      if (data.hasOwnProperty('expires_in')) {
+        obj['expires_in'] = ApiClient.convertToType(data['expires_in'], 'Number');
+      }
       if (data.hasOwnProperty('field_overrides')) {
         obj['field_overrides'] = ApiClient.convertToType(data['field_overrides'], Object);
       }
@@ -109,6 +113,10 @@
    * @member {Array.<module:model/CreateSubmissionDataRequestData>} data_requests
    */
   exports.prototype['data_requests'] = undefined;
+  /**
+   * @member {Number} expires_in
+   */
+  exports.prototype['expires_in'] = undefined;
   /**
    * @member {Object} field_overrides
    */

package/src/model/SubmissionDataBatchRequest.js

@@ -36,7 +36,7 @@
   /**
    * The SubmissionDataBatchRequest model module.
    * @module model/SubmissionDataBatchRequest
-   * @version 1.3.2
+   * @version 1.5.0
    */
 
   /**

package/src/model/SubmissionDataRequest.js

@@ -36,7 +36,7 @@
   /**
    * The SubmissionDataRequest model module.
    * @module model/SubmissionDataRequest
-   * @version 1.3.2
+   * @version 1.5.0
    */
 
   /**
@@ -56,6 +56,7 @@
     var _this = this;
 
     _this['id'] = id;
+
     _this['name'] = name;
     _this['email'] = email;
     _this['order'] = order;
@@ -91,6 +92,9 @@
       if (data.hasOwnProperty('id')) {
         obj['id'] = ApiClient.convertToType(data['id'], 'String');
       }
+      if (data.hasOwnProperty('submission_id')) {
+        obj['submission_id'] = ApiClient.convertToType(data['submission_id'], 'String');
+      }
       if (data.hasOwnProperty('name')) {
         obj['name'] = ApiClient.convertToType(data['name'], 'String');
       }
@@ -156,6 +160,10 @@
    * @member {String} id
    */
   exports.prototype['id'] = undefined;
+  /**
+   * @member {String} submission_id
+   */
+  exports.prototype['submission_id'] = undefined;
   /**
    * @member {String} name
    */

package/src/model/Template.js

@@ -36,7 +36,7 @@
   /**
    * The Template model module.
    * @module model/Template
-   * @version 1.3.2
+   * @version 1.5.0
    */
 
   /**

package/src/model/TemplateData.js

@@ -36,7 +36,7 @@
   /**
    * The TemplateData model module.
    * @module model/TemplateData
-   * @version 1.3.2
+   * @version 1.5.0
    */
 
   /**

package/src/model/TemplatestemplateIdaddFieldsFields.js

@@ -36,7 +36,7 @@
   /**
    * The TemplatestemplateIdaddFieldsFields model module.
    * @module model/TemplatestemplateIdaddFieldsFields
-   * @version 1.3.2
+   * @version 1.5.0
    */
 
   /**
@@ -130,6 +130,7 @@
 
 
 
+
 
 
   };
@@ -334,6 +335,9 @@
       if (data.hasOwnProperty('falseText')) {
         obj['falseText'] = ApiClient.convertToType(data['falseText'], 'String');
       }
+      if (data.hasOwnProperty('placeholder')) {
+        obj['placeholder'] = ApiClient.convertToType(data['placeholder'], 'String');
+      }
       if (data.hasOwnProperty('strikethrough')) {
         obj['strikethrough'] = ApiClient.convertToType(data['strikethrough'], 'Boolean');
       }
@@ -656,6 +660,10 @@
    * @member {String} falseText
    */
   exports.prototype['falseText'] = undefined;
+  /**
+   * @member {String} placeholder
+   */
+  exports.prototype['placeholder'] = undefined;
   /**
    * @member {Boolean} strikethrough
    */

package/src/model/UpdateDataRequestResponse.js

@@ -36,7 +36,7 @@
   /**
    * The UpdateDataRequestResponse model module.
    * @module model/UpdateDataRequestResponse
-   * @version 1.3.2
+   * @version 1.5.0
    */
 
   /**

package/src/model/UpdateSubmissionDataRequestData.js

@@ -36,7 +36,7 @@
   /**
    * The UpdateSubmissionDataRequestData model module.
    * @module model/UpdateSubmissionDataRequestData
-   * @version 1.3.2
+   * @version 1.5.0
    */
 
   /**

package/src/model/UpdateTemplateData.js

@@ -36,7 +36,7 @@
   /**
    * The UpdateTemplateData model module.
    * @module model/UpdateTemplateData
-   * @version 1.3.2
+   * @version 1.5.0
    */
 
   /**

package/src/model/UpdateTemplateResponse.js

@@ -36,7 +36,7 @@
   /**
    * The UpdateTemplateResponse model module.
    * @module model/UpdateTemplateResponse
-   * @version 1.3.2
+   * @version 1.5.0
    */
 
   /**

package/src/model/UploadTemplateData.js

@@ -36,7 +36,7 @@
   /**
    * The UploadTemplateData model module.
    * @module model/UploadTemplateData
-   * @version 1.3.2
+   * @version 1.5.0
    */
 
   /**

package/src/model/UploadTemplateDataDocument.js

@@ -36,7 +36,7 @@
   /**
    * The UploadTemplateDataDocument model module.
    * @module model/UploadTemplateDataDocument
-   * @version 1.3.2
+   * @version 1.5.0
    */
 
   /**

package/src/model/UploadTemplateDataDocumentMetadata.js

@@ -36,7 +36,7 @@
   /**
    * The UploadTemplateDataDocumentMetadata model module.
    * @module model/UploadTemplateDataDocumentMetadata
-   * @version 1.3.2
+   * @version 1.5.0
    */
 
   /**

package/test/api/ClientIntegration.spec.js

@@ -125,74 +125,94 @@
         var submission_data = {
           editable: false,
           data: {
-            title: 'Test PDF',
-            description: 'This PDF is great!',
+            first_name: 'John',
+            last_name: 'Smith',
+            phone_number: '+11234567890',
           },
           metadata: {
             user_id: 123,
           },
           field_overrides: {
-            title: {
+            phone_number: {
               required: false,
             },
           },
           wait: true,
         }
-        docspring.generatePDF(template_id, submission_data, function (
-          error,
-          response
-        ) {
-          if (error) {
-            console.log(response, error)
-            throw error
+        docspring.generatePDF(
+          template_id,
+          submission_data,
+          function (error, response) {
+            if (error) {
+              console.log(response, error)
+              throw error
+            }
+            var submission = response.submission
+            expect(response.status).to.be('success')
+            expect(submission.id).to.match(/^sub_/)
+            expect(submission.expired).to.be(false)
+            expect(submission.editable).to.be(false)
+            expect(submission.state).to.be('processed')
+            expect(submission.download_url).to.not.be(null)
+            expect(submission.download_url).to.not.be('')
+            done()
           }
-          var submission = response.submission
-          expect(response.status).to.be('success')
-          expect(submission.id).to.match(/^sub_/)
-          expect(submission.expired).to.be(false)
-          expect(submission.editable).to.be(false)
-          expect(submission.state).to.be('processed')
-          expect(submission.download_url).to.not.be(null)
-          expect(submission.download_url).to.not.be('')
-          done()
-        })
+        )
       })
-    })
 
-    describe('generatePDF', function () {
       it('should call generatePDF and not wait for the PDF', function (done) {
         this.timeout(10000)
         var template_id = 'tpl_000000000000000001'
         var submission_data = {
           editable: false,
           data: {
-            title: 'Test PDF',
-            description: 'This PDF is great!',
+            first_name: 'John',
+            last_name: 'Smith',
+            phone_number: '+11234567890',
           },
           metadata: {
             user_id: 123,
           },
           field_overrides: {
-            title: {
+            phone_number: {
               required: false,
             },
           },
           wait: false,
         }
-        docspring.generatePDF(template_id, submission_data, function (
-          error,
-          response
-        ) {
+        docspring.generatePDF(
+          template_id,
+          submission_data,
+          function (error, response) {
+            if (error) {
+              console.log(response, error)
+              throw error
+            }
+            var submission = response.submission
+            expect(response.status).to.be('success')
+            expect(submission.id).to.match(/^sub_/)
+            expect(submission.expired).to.be(false)
+            expect(submission.editable).to.be(false)
+            expect(submission.state).to.be('pending')
+            done()
+          }
+        )
+      })
+    })
+
+    describe('getTemplate', function () {
+      it('should call getTemplate successfully', function (done) {
+        this.timeout(10000)
+        var template_id = 'tpl_000000000000000001'
+
+        docspring.getTemplate(template_id, function (error, template) {
           if (error) {
-            console.log(response, error)
+            console.log(template, error)
             throw error
           }
-          var submission = response.submission
-          expect(response.status).to.be('success')
-          expect(submission.id).to.match(/^sub_/)
-          expect(submission.expired).to.be(false)
-          expect(submission.editable).to.be(false)
-          expect(submission.state).to.be('pending')
+          expect(template.id).to.be(template_id)
+          expect(template.name).to.be('API Client Test Template 1')
+          expect(template.template_type).to.be('pdf')
           done()
         })
       })
@@ -208,14 +228,15 @@
             html: '<html><body>New HTML</html></body>',
           },
         }
-        docspring.updateTemplate(template_id, template_data, function (
-          error,
-          response
-        ) {
-          if (error) throw error
-          expect(response.status).to.be('success')
-          done()
-        })
+        docspring.updateTemplate(
+          template_id,
+          template_data,
+          function (error, response) {
+            if (error) throw error
+            expect(response.status).to.be('success')
+            done()
+          }
+        )
       })
     })
 
@@ -240,19 +261,20 @@
             },
           ],
         }
-        docspring.addFieldsToTemplate(template_id, newFieldData, function (
-          error,
-          response
-        ) {
-          if (error) {
-            console.log(response, error)
-            throw error
+        docspring.addFieldsToTemplate(
+          template_id,
+          newFieldData,
+          function (error, response) {
+            if (error) {
+              console.log(response, error)
+              throw error
+            }
+            expect(response.status).to.be('success')
+            expect(response.new_field_ids).to.eql([4, 5])
+            expect(response.errors).to.be(undefined)
+            done()
           }
-          expect(response.status).to.be('success')
-          expect(response.new_field_ids).to.eql([3, 4])
-          expect(response.errors).to.be(undefined)
-          done()
-        })
+        )
       })
     })
   })