docspring 1.4.0 → 1.5.0

package/test/api/ClientIntegration.spec.js

@@ -125,37 +125,39 @@
         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()
-        })
+        )
       })
 
       it('should call generatePDF and not wait for the PDF', function (done) {
@@ -164,35 +166,37 @@
         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
-        ) {
-          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('pending')
+            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('pending')
-          done()
-        })
+        )
       })
     })
 
@@ -224,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()
+          }
+        )
       })
     })
 
@@ -256,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()
-        })
+        )
       })
     })
   })

package/test/api/PDFApi.spec.js.original

@@ -180,6 +180,16 @@
         done();
       });
     });
+    describe('deleteTemplate', function() {
+      it('should call deleteTemplate successfully', function(done) {
+        //uncomment below and update the code to test deleteTemplate
+        //instance.deleteTemplate(function(error) {
+        //  if (error) throw error;
+        //expect().to.be();
+        //});
+        done();
+      });
+    });
     describe('expireCombinedSubmission', function() {
       it('should call expireCombinedSubmission successfully', function(done) {
         //uncomment below and update the code to test expireCombinedSubmission
@@ -290,6 +300,16 @@
         done();
       });
     });
+    describe('listCombinedSubmissions', function() {
+      it('should call listCombinedSubmissions successfully', function(done) {
+        //uncomment below and update the code to test listCombinedSubmissions
+        //instance.listCombinedSubmissions(function(error) {
+        //  if (error) throw error;
+        //expect().to.be();
+        //});
+        done();
+      });
+    });
     describe('listFolders', function() {
       it('should call listFolders successfully', function(done) {
         //uncomment below and update the code to test listFolders

package/test/api/PDFApiIntegration.spec.js

@@ -50,46 +50,48 @@
           submissions: [
             {
               data: {
-                title: 'Test PDF',
-                description: 'This PDF is great!',
+                first_name: 'John',
+                last_name: 'Smith',
+                phone_number: '+11234567890',
               },
             },
             {
               data: {
-                title: 'Test PDF 2',
-                description: 'This PDF is also great!',
+                first_name: 'Jane',
+                last_name: 'Doe',
+                phone_number: '+64215556789',
               },
             },
           ],
         }
 
-        instance.batchGeneratePdfs(submissionBatchData, function (
-          error,
-          response
-        ) {
-          if (error) {
-            console.log(response, error)
-            throw error
+        instance.batchGeneratePdfs(
+          submissionBatchData,
+          function (error, response) {
+            if (error) {
+              console.log(response, error)
+              throw error
+            }
+            expect(response.status).to.be('success')
+            expect(response.submissions.length).to.be(2)
+            var firstSubmission = response.submissions[0]
+            expect(firstSubmission.status).to.be('success')
+            expect(firstSubmission.submission.id).to.match(/^sub_/)
+            expect(firstSubmission.submission.expired).to.be(false)
+            expect(firstSubmission.submission.state).to.be('pending')
+            var secondSubmission = response.submissions[1]
+            expect(secondSubmission.status).to.be('success')
+            expect(secondSubmission.submission.id).to.match(/^sub_/)
+            expect(secondSubmission.submission.expired).to.be(false)
+            expect(secondSubmission.submission.state).to.be('pending')
+            var batch = response.submission_batch
+            expect(batch.id).to.match(/^sbb_/)
+            expect(batch.state).to.be('pending')
+            expect(batch.total_count).to.be(2)
+            expect(batch.pending_count).to.be(2)
+            done()
           }
-          expect(response.status).to.be('success')
-          expect(response.submissions.length).to.be(2)
-          var firstSubmission = response.submissions[0]
-          expect(firstSubmission.status).to.be('success')
-          expect(firstSubmission.submission.id).to.match(/^sub_/)
-          expect(firstSubmission.submission.expired).to.be(false)
-          expect(firstSubmission.submission.state).to.be('pending')
-          var secondSubmission = response.submissions[1]
-          expect(secondSubmission.status).to.be('success')
-          expect(secondSubmission.submission.id).to.match(/^sub_/)
-          expect(secondSubmission.submission.expired).to.be(false)
-          expect(secondSubmission.submission.state).to.be('pending')
-          var batch = response.submission_batch
-          expect(batch.id).to.match(/^sbb_/)
-          expect(batch.state).to.be('pending')
-          expect(batch.total_count).to.be(2)
-          expect(batch.pending_count).to.be(2)
-          done()
-        })
+        )
       })
     })
 
@@ -110,14 +112,14 @@
     describe('expireCombinedSubmission', function () {
       it('should call expireCombinedSubmission successfully', function (done) {
         var combinedSubmissionId = 'com_000000000000000001'
-        instance.expireCombinedSubmission(combinedSubmissionId, function (
-          error,
-          response
-        ) {
-          if (error) throw error
-          expect(response.expired).to.be(true)
-          done()
-        })
+        instance.expireCombinedSubmission(
+          combinedSubmissionId,
+          function (error, response) {
+            if (error) throw error
+            expect(response.expired).to.be(true)
+            done()
+          }
+        )
       })
     })
     describe('expireSubmission', function () {
@@ -135,22 +137,24 @@
         var templateId = 'tpl_000000000000000001'
         var submissionData = {
           data: {
-            title: 'Test PDF',
-            description: 'This PDF is great!',
+            first_name: 'John',
+            last_name: 'Smith',
+            phone_number: '+11234567890',
           },
         }
-        instance.generatePDF(templateId, submissionData, function (
-          error,
-          response
-        ) {
-          if (error) throw error
-          expect(response.status).to.be('success')
-          var submission = response.submission
-          expect(submission.id).to.match(/^sub_/)
-          expect(submission.expired).to.be(false)
-          expect(submission.state).to.be('pending')
-          done()
-        })
+        instance.generatePDF(
+          templateId,
+          submissionData,
+          function (error, response) {
+            if (error) throw error
+            expect(response.status).to.be('success')
+            var submission = response.submission
+            expect(submission.id).to.match(/^sub_/)
+            expect(submission.expired).to.be(false)
+            expect(submission.state).to.be('pending')
+            done()
+          }
+        )
       })
     })
     describe('generatePDF with data_requests', function () {
@@ -158,56 +162,57 @@
         var templateId = 'tpl_000000000000000001'
         var submissionData = {
           data: {
-            title: 'Test PDF',
-            description: 'This PDF is great!',
+            first_name: 'John',
+            last_name: 'Smith',
           },
           data_requests: [
             {
               name: 'John Smith',
               email: 'jsmith@example.com',
-              fields: ['description'],
+              fields: ['phone_number'],
               order: 1,
               auth_type: 'email_link',
             },
           ],
         }
-        instance.generatePDF(templateId, submissionData, function (
-          error,
-          response
-        ) {
-          if (error) throw error
-          expect(response.status).to.be('success')
-          var submission = response.submission
-          expect(submission.id).to.match(/^sub_/)
-          expect(submission.expired).to.be(false)
-          expect(submission.state).to.be('waiting_for_data_requests')
+        instance.generatePDF(
+          templateId,
+          submissionData,
+          function (error, response) {
+            if (error) throw error
+            expect(response.status).to.be('success')
+            var submission = response.submission
+            expect(submission.id).to.match(/^sub_/)
+            expect(submission.expired).to.be(false)
+            expect(submission.state).to.be('waiting_for_data_requests')
 
-          var data_requests = submission.data_requests
-          expect(data_requests.length).to.be(1)
-          var data_request = data_requests[0]
+            var data_requests = submission.data_requests
+            expect(data_requests.length).to.be(1)
+            var data_request = data_requests[0]
 
-          expect(data_request.id).to.match(/^drq_/)
-          expect(data_request.state).to.be('pending')
-          expect(data_request.fields).to.eql(['description'])
-          expect(data_request.order).to.be(1)
-          expect(data_request.name).to.be('John Smith')
-          expect(data_request.email).to.be('jsmith@example.com')
+            expect(data_request.id).to.match(/^drq_/)
+            expect(data_request.state).to.be('pending')
+            expect(data_request.fields).to.eql(['phone_number'])
+            expect(data_request.order).to.be(1)
+            expect(data_request.name).to.be('John Smith')
+            expect(data_request.email).to.be('jsmith@example.com')
 
-          done()
-        })
+            done()
+          }
+        )
       })
     })
     describe('getCombinedSubmission', function () {
       it('should call getCombinedSubmission successfully', function (done) {
         var combinedSubmissionId = 'com_000000000000000001'
-        instance.getCombinedSubmission(combinedSubmissionId, function (
-          error,
-          response
-        ) {
-          if (error) throw error
-          expect(response.id).to.match(/^com_/)
-          done()
-        })
+        instance.getCombinedSubmission(
+          combinedSubmissionId,
+          function (error, response) {
+            if (error) throw error
+            expect(response.id).to.match(/^com_/)
+            done()
+          }
+        )
       })
     })
     describe('getSubmission', function () {
@@ -284,17 +289,16 @@
             footer_html: 'Test Footer',
           },
         }
-        instance.createHTMLTemplate(templateData, function (
-          error,
-          data,
-          response
-        ) {
-          if (error) throw error
-          expect(data.name).to.be('Test HTML Template')
-          expect(data.description).to.be('HTML template created via API')
-          expect(data.id).to.match(/^tpl_/)
-          done()
-        })
+        instance.createHTMLTemplate(
+          templateData,
+          function (error, data, response) {
+            if (error) throw error
+            expect(data.name).to.be('Test HTML Template')
+            expect(data.description).to.be('HTML template created via API')
+            expect(data.id).to.match(/^tpl_/)
+            done()
+          }
+        )
       })
     })
   })

package/test/model/CombinedSubmission.spec.js

@@ -56,6 +56,12 @@
       //expect(instance).to.be.a(DocSpring.CombinedSubmission);
     });
 
+    it('should have the property errorMessage (base name: "error_message")', function() {
+      // uncomment below and update the code to test the property errorMessage
+      //var instance = new DocSpring.CombinedSubmission();
+      //expect(instance).to.be();
+    });
+
     it('should have the property metadata (base name: "metadata")', function() {
       // uncomment below and update the code to test the property metadata
       //var instance = new DocSpring.CombinedSubmission();
@@ -116,6 +122,12 @@
       //expect(instance).to.be();
     });
 
+    it('should have the property expiresIn (base name: "expires_in")', function() {
+      // uncomment below and update the code to test the property expiresIn
+      //var instance = new DocSpring.CombinedSubmission();
+      //expect(instance).to.be();
+    });
+
     it('should have the property actions (base name: "actions")', function() {
       // uncomment below and update the code to test the property actions
       //var instance = new DocSpring.CombinedSubmission();

package/test/model/SubmissionData.spec.js

@@ -74,6 +74,12 @@
       //expect(instance).to.be();
     });
 
+    it('should have the property expiresIn (base name: "expires_in")', function() {
+      // uncomment below and update the code to test the property expiresIn
+      //var instance = new DocSpring.SubmissionData();
+      //expect(instance).to.be();
+    });
+
     it('should have the property fieldOverrides (base name: "field_overrides")', function() {
       // uncomment below and update the code to test the property fieldOverrides
       //var instance = new DocSpring.SubmissionData();

package/test/model/SubmissionDataRequest.spec.js

@@ -62,6 +62,12 @@
       //expect(instance).to.be();
     });
 
+    it('should have the property submissionId (base name: "submission_id")', function() {
+      // uncomment below and update the code to test the property submissionId
+      //var instance = new DocSpring.SubmissionDataRequest();
+      //expect(instance).to.be();
+    });
+
     it('should have the property name (base name: "name")', function() {
       // uncomment below and update the code to test the property name
       //var instance = new DocSpring.SubmissionDataRequest();