docspring 1.5.0 → 2.1.0

package/test/api/PDFApiIntegration.spec.js

@@ -1,305 +0,0 @@
-/**
- * API V1
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
- *
- * OpenAPI spec version: v1
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- *
- * OpenAPI Generator version: 3.3.0-SNAPSHOT
- *
- * Do not edit the class manually.
- *
- */
-
-;(function (root, factory) {
-  if (typeof define === 'function' && define.amd) {
-    // AMD.
-    define(['expect.js', '../../src/index'], factory)
-  } else if (typeof module === 'object' && module.exports) {
-    // CommonJS-like environments that support module.exports, like Node.
-    factory(require('expect.js'), require('../../src/index'))
-  } else {
-    // Browser globals (root is window)
-    factory(root.expect, root.DocSpring)
-  }
-})(this, function (expect, DocSpring) {
-  'use strict'
-
-  var instance
-
-  beforeEach(function () {
-    // We test the default configuration in this test,
-    // and a configuration instance in Client.spec.js
-    var defaultConfiguration = DocSpring.Configuration.instance
-    // Configure HTTP basic authorization: api_token_basic
-    defaultConfiguration.apiTokenId = 'api_token123'
-    defaultConfiguration.apiTokenSecret = 'testsecret123'
-    defaultConfiguration.basePath = 'http://api.docspring.local:31337/api/v1'
-    instance = new DocSpring.PDFApi()
-  })
-
-  describe('PDFApi', function () {
-    describe('batchGeneratePdfs', function () {
-      it('should call batchGeneratePdfs successfully', function (done) {
-        var submissionBatchData = {
-          test: true,
-          template_id: 'tpl_000000000000000001',
-          metadata: { user_id: 42 },
-          submissions: [
-            {
-              data: {
-                first_name: 'John',
-                last_name: 'Smith',
-                phone_number: '+11234567890',
-              },
-            },
-            {
-              data: {
-                first_name: 'Jane',
-                last_name: 'Doe',
-                phone_number: '+64215556789',
-              },
-            },
-          ],
-        }
-
-        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()
-          }
-        )
-      })
-    })
-
-    describe('combineSubmissions', function () {
-      it('should call combineSubmissions successfully', function (done) {
-        var opts = {
-          submission_ids: ['sub_000000000000000001', 'sub_000000000000000002'],
-        }
-        instance.combineSubmissions(opts, function (error, response) {
-          if (error) throw error
-          expect(response.status).to.be('success')
-          expect(response.combined_submission.id).to.match(/^com_/)
-          expect(response.combined_submission.state).to.be('pending')
-          done()
-        })
-      })
-    })
-    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()
-          }
-        )
-      })
-    })
-    describe('expireSubmission', function () {
-      it('should call expireSubmission successfully', function (done) {
-        var submissionId = 'sub_000000000000000001'
-        instance.expireSubmission(submissionId, function (error, response) {
-          if (error) throw error
-          expect(response.expired).to.be(true)
-          done()
-        })
-      })
-    })
-    describe('generatePDF', function () {
-      it('should call generatePDF successfully', function (done) {
-        var templateId = 'tpl_000000000000000001'
-        var submissionData = {
-          data: {
-            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()
-          }
-        )
-      })
-    })
-    describe('generatePDF with data_requests', function () {
-      it('should call generatePDF with data_requests successfully', function (done) {
-        var templateId = 'tpl_000000000000000001'
-        var submissionData = {
-          data: {
-            first_name: 'John',
-            last_name: 'Smith',
-          },
-          data_requests: [
-            {
-              name: 'John Smith',
-              email: 'jsmith@example.com',
-              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')
-
-            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(['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()
-          }
-        )
-      })
-    })
-    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()
-          }
-        )
-      })
-    })
-    describe('getSubmission', function () {
-      it('should call getSubmission successfully', function (done) {
-        var submissionId = 'sub_000000000000000001'
-        instance.getSubmission(submissionId, {}, function (error, response) {
-          if (error) throw error
-          expect(response.id).to.match(/^sub_/)
-          done()
-        })
-      })
-    })
-    describe('listTemplates', function () {
-      it('should call listTemplates successfully', function (done) {
-        var opts = {
-          query: 'API Client Test Template 2',
-          page: 1,
-          per_page: 10,
-        }
-        instance.listTemplates(opts, function (error, templates) {
-          if (error) throw error
-          expect(templates.length).to.be(1)
-          expect(templates[0].id).to.be('tpl_000000000000000002')
-          done()
-        })
-      })
-    })
-    describe('testAuthentication', function () {
-      it('should call testAuthentication successfully', function (done) {
-        instance.testAuthentication(function (error, response) {
-          if (error) throw error
-          expect(response.status).to.be('success')
-          done()
-        })
-      })
-    })
-    describe('createPDFTemplate', function () {
-      it('should call createPDFTemplate successfully', function (done) {
-        this.timeout(10000)
-        var fs = require('fs')
-        var templateDocument = fs.createReadStream(
-          '../../../spec/fixtures/all_features.pdf'
-        ) // File |
-        var templateName = 'testPDFTemplate' // String |
-        var parentFolderId = null
-        instance.createPDFTemplate(
-          templateDocument,
-          templateName,
-          parentFolderId,
-          function (error, data, response) {
-            if (error) throw error
-            expect(data.name).to.be('testPDFTemplate')
-            expect(data.id).to.match(/^tpl_/)
-            done()
-          }
-        )
-      })
-    })
-
-    describe('createHTMLTemplate', function () {
-      it('should call createHTMLTemplate successfully', function (done) {
-        this.timeout(10000)
-        var templateName = 'testHTMLTemplate' // String |
-
-        var parentFolderId = null
-        var templateData = {
-          template: {
-            name: 'Test HTML Template',
-            description: 'HTML template created via API',
-            template_type: 'html',
-            html: '<html><body><p>Test Content</p></body></html>',
-            scss: 'body { color: #444; }',
-            header_html: 'Test Header',
-            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()
-          }
-        )
-      })
-    })
-  })
-})

package/test/model/AddFieldsData.spec.js

@@ -1,67 +0,0 @@
-/**
- * API v1
- * DocSpring is a service that helps you fill out and sign PDF templates.
- *
- * OpenAPI spec version: v1
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- *
- * OpenAPI Generator version: 3.3.0
- *
- * Do not edit the class manually.
- *
- */
-
-(function(root, factory) {
-  if (typeof define === 'function' && define.amd) {
-    // AMD.
-    define(['expect.js', '../../src/index'], factory);
-  } else if (typeof module === 'object' && module.exports) {
-    // CommonJS-like environments that support module.exports, like Node.
-    factory(require('expect.js'), require('../../src/index'));
-  } else {
-    // Browser globals (root is window)
-    factory(root.expect, root.DocSpring);
-  }
-}(this, function(expect, DocSpring) {
-  'use strict';
-
-  var instance;
-
-  beforeEach(function() {
-    instance = new DocSpring.AddFieldsData();
-  });
-
-  var getProperty = function(object, getter, property) {
-    // Use getter method if present; otherwise, get the property directly.
-    if (typeof object[getter] === 'function')
-      return object[getter]();
-    else
-      return object[property];
-  }
-
-  var setProperty = function(object, setter, property, value) {
-    // Use setter method if present; otherwise, set the property directly.
-    if (typeof object[setter] === 'function')
-      object[setter](value);
-    else
-      object[property] = value;
-  }
-
-  describe('AddFieldsData', function() {
-    it('should create an instance of AddFieldsData', function() {
-      // uncomment below and update the code to test AddFieldsData
-      //var instance = new DocSpring.AddFieldsData();
-      //expect(instance).to.be.a(DocSpring.AddFieldsData);
-    });
-
-    it('should have the property fields (base name: "fields")', function() {
-      // uncomment below and update the code to test the property fields
-      //var instance = new DocSpring.AddFieldsData();
-      //expect(instance).to.be();
-    });
-
-  });
-
-}));

package/test/model/AddFieldsTemplateResponse.spec.js

@@ -1,79 +0,0 @@
-/**
- * API v1
- * DocSpring is a service that helps you fill out and sign PDF templates.
- *
- * OpenAPI spec version: v1
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- *
- * OpenAPI Generator version: 3.3.0
- *
- * Do not edit the class manually.
- *
- */
-
-(function(root, factory) {
-  if (typeof define === 'function' && define.amd) {
-    // AMD.
-    define(['expect.js', '../../src/index'], factory);
-  } else if (typeof module === 'object' && module.exports) {
-    // CommonJS-like environments that support module.exports, like Node.
-    factory(require('expect.js'), require('../../src/index'));
-  } else {
-    // Browser globals (root is window)
-    factory(root.expect, root.DocSpring);
-  }
-}(this, function(expect, DocSpring) {
-  'use strict';
-
-  var instance;
-
-  beforeEach(function() {
-    instance = new DocSpring.AddFieldsTemplateResponse();
-  });
-
-  var getProperty = function(object, getter, property) {
-    // Use getter method if present; otherwise, get the property directly.
-    if (typeof object[getter] === 'function')
-      return object[getter]();
-    else
-      return object[property];
-  }
-
-  var setProperty = function(object, setter, property, value) {
-    // Use setter method if present; otherwise, set the property directly.
-    if (typeof object[setter] === 'function')
-      object[setter](value);
-    else
-      object[property] = value;
-  }
-
-  describe('AddFieldsTemplateResponse', function() {
-    it('should create an instance of AddFieldsTemplateResponse', function() {
-      // uncomment below and update the code to test AddFieldsTemplateResponse
-      //var instance = new DocSpring.AddFieldsTemplateResponse();
-      //expect(instance).to.be.a(DocSpring.AddFieldsTemplateResponse);
-    });
-
-    it('should have the property newFieldIds (base name: "new_field_ids")', function() {
-      // uncomment below and update the code to test the property newFieldIds
-      //var instance = new DocSpring.AddFieldsTemplateResponse();
-      //expect(instance).to.be();
-    });
-
-    it('should have the property errors (base name: "errors")', function() {
-      // uncomment below and update the code to test the property errors
-      //var instance = new DocSpring.AddFieldsTemplateResponse();
-      //expect(instance).to.be();
-    });
-
-    it('should have the property status (base name: "status")', function() {
-      // uncomment below and update the code to test the property status
-      //var instance = new DocSpring.AddFieldsTemplateResponse();
-      //expect(instance).to.be();
-    });
-
-  });
-
-}));

package/test/model/AuthenticationError.spec.js

@@ -1,73 +0,0 @@
-/**
- * API v1
- * DocSpring is a service that helps you fill out and sign PDF templates.
- *
- * OpenAPI spec version: v1
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- *
- * OpenAPI Generator version: 3.3.0
- *
- * Do not edit the class manually.
- *
- */
-
-(function(root, factory) {
-  if (typeof define === 'function' && define.amd) {
-    // AMD.
-    define(['expect.js', '../../src/index'], factory);
-  } else if (typeof module === 'object' && module.exports) {
-    // CommonJS-like environments that support module.exports, like Node.
-    factory(require('expect.js'), require('../../src/index'));
-  } else {
-    // Browser globals (root is window)
-    factory(root.expect, root.DocSpring);
-  }
-}(this, function(expect, DocSpring) {
-  'use strict';
-
-  var instance;
-
-  beforeEach(function() {
-    instance = new DocSpring.AuthenticationError();
-  });
-
-  var getProperty = function(object, getter, property) {
-    // Use getter method if present; otherwise, get the property directly.
-    if (typeof object[getter] === 'function')
-      return object[getter]();
-    else
-      return object[property];
-  }
-
-  var setProperty = function(object, setter, property, value) {
-    // Use setter method if present; otherwise, set the property directly.
-    if (typeof object[setter] === 'function')
-      object[setter](value);
-    else
-      object[property] = value;
-  }
-
-  describe('AuthenticationError', function() {
-    it('should create an instance of AuthenticationError', function() {
-      // uncomment below and update the code to test AuthenticationError
-      //var instance = new DocSpring.AuthenticationError();
-      //expect(instance).to.be.a(DocSpring.AuthenticationError);
-    });
-
-    it('should have the property status (base name: "status")', function() {
-      // uncomment below and update the code to test the property status
-      //var instance = new DocSpring.AuthenticationError();
-      //expect(instance).to.be();
-    });
-
-    it('should have the property error (base name: "error")', function() {
-      // uncomment below and update the code to test the property error
-      //var instance = new DocSpring.AuthenticationError();
-      //expect(instance).to.be();
-    });
-
-  });
-
-}));

package/test/model/AuthenticationSuccessResponse.spec.js

@@ -1,67 +0,0 @@
-/**
- * API v1
- * DocSpring is a service that helps you fill out and sign PDF templates.
- *
- * OpenAPI spec version: v1
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- *
- * OpenAPI Generator version: 3.3.0
- *
- * Do not edit the class manually.
- *
- */
-
-(function(root, factory) {
-  if (typeof define === 'function' && define.amd) {
-    // AMD.
-    define(['expect.js', '../../src/index'], factory);
-  } else if (typeof module === 'object' && module.exports) {
-    // CommonJS-like environments that support module.exports, like Node.
-    factory(require('expect.js'), require('../../src/index'));
-  } else {
-    // Browser globals (root is window)
-    factory(root.expect, root.DocSpring);
-  }
-}(this, function(expect, DocSpring) {
-  'use strict';
-
-  var instance;
-
-  beforeEach(function() {
-    instance = new DocSpring.AuthenticationSuccessResponse();
-  });
-
-  var getProperty = function(object, getter, property) {
-    // Use getter method if present; otherwise, get the property directly.
-    if (typeof object[getter] === 'function')
-      return object[getter]();
-    else
-      return object[property];
-  }
-
-  var setProperty = function(object, setter, property, value) {
-    // Use setter method if present; otherwise, set the property directly.
-    if (typeof object[setter] === 'function')
-      object[setter](value);
-    else
-      object[property] = value;
-  }
-
-  describe('AuthenticationSuccessResponse', function() {
-    it('should create an instance of AuthenticationSuccessResponse', function() {
-      // uncomment below and update the code to test AuthenticationSuccessResponse
-      //var instance = new DocSpring.AuthenticationSuccessResponse();
-      //expect(instance).to.be.a(DocSpring.AuthenticationSuccessResponse);
-    });
-
-    it('should have the property status (base name: "status")', function() {
-      // uncomment below and update the code to test the property status
-      //var instance = new DocSpring.AuthenticationSuccessResponse();
-      //expect(instance).to.be();
-    });
-
-  });
-
-}));

package/test/model/CombinePdfsData.spec.js

@@ -1,97 +0,0 @@
-/**
- * API v1
- * DocSpring is a service that helps you fill out and sign PDF templates.
- *
- * OpenAPI spec version: v1
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- *
- * OpenAPI Generator version: 3.3.0
- *
- * Do not edit the class manually.
- *
- */
-
-(function(root, factory) {
-  if (typeof define === 'function' && define.amd) {
-    // AMD.
-    define(['expect.js', '../../src/index'], factory);
-  } else if (typeof module === 'object' && module.exports) {
-    // CommonJS-like environments that support module.exports, like Node.
-    factory(require('expect.js'), require('../../src/index'));
-  } else {
-    // Browser globals (root is window)
-    factory(root.expect, root.DocSpring);
-  }
-}(this, function(expect, DocSpring) {
-  'use strict';
-
-  var instance;
-
-  beforeEach(function() {
-    instance = new DocSpring.CombinePdfsData();
-  });
-
-  var getProperty = function(object, getter, property) {
-    // Use getter method if present; otherwise, get the property directly.
-    if (typeof object[getter] === 'function')
-      return object[getter]();
-    else
-      return object[property];
-  }
-
-  var setProperty = function(object, setter, property, value) {
-    // Use setter method if present; otherwise, set the property directly.
-    if (typeof object[setter] === 'function')
-      object[setter](value);
-    else
-      object[property] = value;
-  }
-
-  describe('CombinePdfsData', function() {
-    it('should create an instance of CombinePdfsData', function() {
-      // uncomment below and update the code to test CombinePdfsData
-      //var instance = new DocSpring.CombinePdfsData();
-      //expect(instance).to.be.a(DocSpring.CombinePdfsData);
-    });
-
-    it('should have the property deleteCustomFiles (base name: "delete_custom_files")', function() {
-      // uncomment below and update the code to test the property deleteCustomFiles
-      //var instance = new DocSpring.CombinePdfsData();
-      //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.CombinePdfsData();
-      //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.CombinePdfsData();
-      //expect(instance).to.be();
-    });
-
-    it('should have the property password (base name: "password")', function() {
-      // uncomment below and update the code to test the property password
-      //var instance = new DocSpring.CombinePdfsData();
-      //expect(instance).to.be();
-    });
-
-    it('should have the property sourcePdfs (base name: "source_pdfs")', function() {
-      // uncomment below and update the code to test the property sourcePdfs
-      //var instance = new DocSpring.CombinePdfsData();
-      //expect(instance).to.be();
-    });
-
-    it('should have the property test (base name: "test")', function() {
-      // uncomment below and update the code to test the property test
-      //var instance = new DocSpring.CombinePdfsData();
-      //expect(instance).to.be();
-    });
-
-  });
-
-}));