docspring 1.4.0 → 1.5.0

package/src/api/Client.js

@@ -105,291 +105,304 @@
       root.DocSpring.UpdateSubmissionDataRequestData
     )
   }
-})(this, function (
-  PDFApi,
-  ApiClient,
-  AuthenticationError,
-  AuthenticationSuccessResponse,
-  CombinePdfsData,
-  CombinedSubmission,
-  CombinedSubmissionData,
-  CreateCombinedSubmissionResponse,
-  CreateCustomFileData,
-  CreateCustomFileResponse,
-  CreateSubmissionBatchResponse,
-  CreateSubmissionDataRequestTokenResponse,
-  CreateSubmissionResponse,
-  CreateTemplateData,
-  Error,
-  InvalidRequest,
-  PendingTemplate,
-  Submission,
-  SubmissionBatch,
-  SubmissionBatchData,
-  SubmissionData,
-  SubmissionDataRequest,
-  Template,
-  UpdateDataRequestResponse,
-  UpdateSubmissionDataRequestData
-) {
-  'use strict'
+})(
+  this,
+  function (
+    PDFApi,
+    ApiClient,
+    AuthenticationError,
+    AuthenticationSuccessResponse,
+    CombinePdfsData,
+    CombinedSubmission,
+    CombinedSubmissionData,
+    CreateCombinedSubmissionResponse,
+    CreateCustomFileData,
+    CreateCustomFileResponse,
+    CreateSubmissionBatchResponse,
+    CreateSubmissionDataRequestTokenResponse,
+    CreateSubmissionResponse,
+    CreateTemplateData,
+    Error,
+    InvalidRequest,
+    PendingTemplate,
+    Submission,
+    SubmissionBatch,
+    SubmissionBatchData,
+    SubmissionData,
+    SubmissionDataRequest,
+    Template,
+    UpdateDataRequestResponse,
+    UpdateSubmissionDataRequestData
+  ) {
+    'use strict'
 
-  /**
-   * PDF service.
-   * @module api/Client
-   * @version 1.0.0
-   */
+    /**
+     * PDF service.
+     * @module api/Client
+     * @version 1.0.0
+     */
 
-  // Object.create polyfill for very old browsers
-  if (typeof Object.create !== 'function') {
-    Object.create = function (proto, propertiesObject) {
-      if (typeof proto !== 'object' && typeof proto !== 'function') {
-        throw new TypeError('Object prototype may only be an Object: ' + proto)
-      } else if (proto === null) {
-        throw new Error(
-          "This browser's implementation of Object.create is a shim and doesn't support 'null' as the first argument."
-        )
-      }
+    // Object.create polyfill for very old browsers
+    if (typeof Object.create !== 'function') {
+      Object.create = function (proto, propertiesObject) {
+        if (typeof proto !== 'object' && typeof proto !== 'function') {
+          throw new TypeError(
+            'Object prototype may only be an Object: ' + proto
+          )
+        } else if (proto === null) {
+          throw new Error(
+            "This browser's implementation of Object.create is a shim and doesn't support 'null' as the first argument."
+          )
+        }
 
-      if (typeof propertiesObject != 'undefined') {
-        throw new Error(
-          "This browser's implementation of Object.create is a shim and doesn't support a second argument."
-        )
-      }
+        if (typeof propertiesObject != 'undefined') {
+          throw new Error(
+            "This browser's implementation of Object.create is a shim and doesn't support a second argument."
+          )
+        }
 
-      function F() {}
-      F.prototype = proto
+        function F() {}
+        F.prototype = proto
 
-      return new F()
+        return new F()
+      }
     }
-  }
 
-  // Object.assign polyfill
-  if (typeof Object.assign != 'function') {
-    // Must be writable: true, enumerable: false, configurable: true
-    Object.defineProperty(Object, 'assign', {
-      value: function assign(target, varArgs) {
-        // .length of function is 2
-        'use strict'
-        if (target == null) {
-          // TypeError if undefined or null
-          throw new TypeError('Cannot convert undefined or null to object')
-        }
+    // Object.assign polyfill
+    if (typeof Object.assign != 'function') {
+      // Must be writable: true, enumerable: false, configurable: true
+      Object.defineProperty(Object, 'assign', {
+        value: function assign(target, varArgs) {
+          // .length of function is 2
+          'use strict'
+          if (target == null) {
+            // TypeError if undefined or null
+            throw new TypeError('Cannot convert undefined or null to object')
+          }
 
-        var to = Object(target)
+          var to = Object(target)
 
-        for (var index = 1; index < arguments.length; index++) {
-          var nextSource = arguments[index]
+          for (var index = 1; index < arguments.length; index++) {
+            var nextSource = arguments[index]
 
-          if (nextSource != null) {
-            // Skip over if undefined or null
-            for (var nextKey in nextSource) {
-              // Avoid bugs when hasOwnProperty is shadowed
-              if (Object.prototype.hasOwnProperty.call(nextSource, nextKey)) {
-                to[nextKey] = nextSource[nextKey]
+            if (nextSource != null) {
+              // Skip over if undefined or null
+              for (var nextKey in nextSource) {
+                // Avoid bugs when hasOwnProperty is shadowed
+                if (Object.prototype.hasOwnProperty.call(nextSource, nextKey)) {
+                  to[nextKey] = nextSource[nextKey]
+                }
               }
             }
           }
-        }
-        return to
-      },
-      writable: true,
-      configurable: true,
-    })
-  }
+          return to
+        },
+        writable: true,
+        configurable: true,
+      })
+    }
 
-  /**
-   * Constructs a new Client.
-   * @alias module:api/Client
-   * @class
-   * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
-   * default to {@link module:ApiClient#instance} if unspecified.
-   */
-  function Client(apiClient) {
-    this.apiClient = apiClient || ApiClient.instance
-    PDFApi.call(this, this.apiClient)
-    var self = this
+    /**
+     * Constructs a new Client.
+     * @alias module:api/Client
+     * @class
+     * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
+     * default to {@link module:ApiClient#instance} if unspecified.
+     */
+    function Client(apiClient) {
+      this.apiClient = apiClient || ApiClient.instance
+      PDFApi.call(this, this.apiClient)
+      var self = this
 
-    var waitForPDFJob = function (options, startJob, updateRecord, callback) {
-      var timeout = options.timeout != null ? options.timeout : 60
-      var wait = options.wait == null ? true : !!options.wait
+      var waitForPDFJob = function (options, startJob, updateRecord, callback) {
+        var timeout = options.timeout != null ? options.timeout : 60
+        var wait = options.wait == null ? true : !!options.wait
 
-      startJob(function (record) {
-        if (!wait || record.state != 'pending') {
-          callback(
-            null,
-            record,
-            record.state == 'pending' || record.state == 'processed'
-          )
-          return
-        }
-        var startTime = Math.floor(new Date() / 1000)
+        startJob(function (record) {
+          if (!wait || record.state != 'pending') {
+            callback(
+              null,
+              record,
+              record.state == 'pending' || record.state == 'processed'
+            )
+            return
+          }
+          var startTime = Math.floor(new Date() / 1000)
 
-        var waitForPDF = function () {
-          updateRecord(record, function (updatedRecord) {
-            record = updatedRecord
-            if (record.state != 'pending') {
-              callback(null, record, record.state === 'processed')
-              return
-            }
-            var currentTime = Math.floor(new Date() / 1000)
-            if (currentTime - startTime > timeout) {
-              callback(
-                new Error(
-                  'PDF job was not finished after ' + timeout + ' seconds!'
-                ),
-                record,
-                false
-              )
-            }
-            setTimeout(waitForPDF, 1000)
-          })
-        }
-        setTimeout(waitForPDF, 1000)
-      })
-    }
+          var waitForPDF = function () {
+            updateRecord(record, function (updatedRecord) {
+              record = updatedRecord
+              if (record.state != 'pending') {
+                callback(null, record, record.state === 'processed')
+                return
+              }
+              var currentTime = Math.floor(new Date() / 1000)
+              if (currentTime - startTime > timeout) {
+                callback(
+                  new Error(
+                    'PDF job was not finished after ' + timeout + ' seconds!'
+                  ),
+                  record,
+                  false
+                )
+              }
+              setTimeout(waitForPDF, 1000)
+            })
+          }
+          setTimeout(waitForPDF, 1000)
+        })
+      }
 
-    this.originalCombineSubmissions = this.combineSubmissions.bind(this)
-    this.combineSubmissions = function (_options, callback) {
-      // eslint-disable-next-line es5/no-es6-static-methods
-      var options = Object.assign({}, _options)
-      // Don't send timeout or wait options to the API - causes a schema validation error.
-      delete options.timeout
-      delete options.wait
+      this.originalCombineSubmissions = this.combineSubmissions.bind(this)
+      this.combineSubmissions = function (_options, callback) {
+        // eslint-disable-next-line es5/no-es6-static-methods
+        var options = Object.assign({}, _options)
+        // Don't send timeout or wait options to the API - causes a schema validation error.
+        delete options.timeout
+        delete options.wait
 
-      waitForPDFJob(
-        _options,
-        function (waitCallback) {
-          self.originalCombineSubmissions(options, function (error, response) {
-            if (error) {
-              callback(error, response)
-              return
-            }
-            waitCallback(response.combined_submission)
-          })
-        },
-        function (record, updateCallback) {
-          self.getCombinedSubmission(record.id, function (
-            error,
-            combinedSubmission
-          ) {
+        waitForPDFJob(
+          _options,
+          function (waitCallback) {
+            self.originalCombineSubmissions(
+              options,
+              function (error, response) {
+                if (error) {
+                  callback(error, response)
+                  return
+                }
+                waitCallback(response.combined_submission)
+              }
+            )
+          },
+          function (record, updateCallback) {
+            self.getCombinedSubmission(
+              record.id,
+              function (error, combinedSubmission) {
+                if (error) {
+                  callback(error, combinedSubmission)
+                  return
+                }
+                updateCallback(combinedSubmission)
+              }
+            )
+          },
+          function (error, record, success) {
             if (error) {
-              callback(error, combinedSubmission)
+              callback(error, record)
               return
             }
-            updateCallback(combinedSubmission)
-          })
-        },
-        function (error, record, success) {
-          if (error) {
-            callback(error, record)
-            return
+            var response = CreateCombinedSubmissionResponse.constructFromObject(
+              {
+                status: success ? 'success' : 'error',
+                combined_submission: record,
+              }
+            )
+            callback(error, response)
           }
-          var response = CreateCombinedSubmissionResponse.constructFromObject({
-            status: success ? 'success' : 'error',
-            combined_submission: record,
-          })
-          callback(error, response)
-        }
-      )
-    }
+        )
+      }
 
-    this.originalCombinePdfs = this.combinePdfs.bind(this)
-    this.combinePdfs = function (_options, callback) {
-      // eslint-disable-next-line es5/no-es6-static-methods
-      var options = Object.assign({}, _options)
-      // Don't send timeout or wait options to the API - causes a schema validation error.
-      delete options.timeout
-      delete options.wait
+      this.originalCombinePdfs = this.combinePdfs.bind(this)
+      this.combinePdfs = function (_options, callback) {
+        // eslint-disable-next-line es5/no-es6-static-methods
+        var options = Object.assign({}, _options)
+        // Don't send timeout or wait options to the API - causes a schema validation error.
+        delete options.timeout
+        delete options.wait
 
-      waitForPDFJob(
-        _options,
-        function (waitCallback) {
-          self.originalCombinePdfs(options, function (error, response) {
-            if (error) {
-              callback(error, response)
-              return
-            }
-            waitCallback(response.combined_submission)
-          })
-        },
-        function (record, updateCallback) {
-          self.getCombinedSubmission(record.id, function (
-            error,
-            combinedSubmission
-          ) {
+        waitForPDFJob(
+          _options,
+          function (waitCallback) {
+            self.originalCombinePdfs(options, function (error, response) {
+              if (error) {
+                callback(error, response)
+                return
+              }
+              waitCallback(response.combined_submission)
+            })
+          },
+          function (record, updateCallback) {
+            self.getCombinedSubmission(
+              record.id,
+              function (error, combinedSubmission) {
+                if (error) {
+                  callback(error, combinedSubmission)
+                  return
+                }
+                updateCallback(combinedSubmission)
+              }
+            )
+          },
+          function (error, record, success) {
             if (error) {
-              callback(error, combinedSubmission)
+              callback(error, record)
               return
             }
-            updateCallback(combinedSubmission)
-          })
-        },
-        function (error, record, success) {
-          if (error) {
-            callback(error, record)
-            return
+            var response = CreateCombinedSubmissionResponse.constructFromObject(
+              {
+                status: success ? 'success' : 'error',
+                combined_submission: record,
+              }
+            )
+            callback(error, response)
           }
-          var response = CreateCombinedSubmissionResponse.constructFromObject({
-            status: success ? 'success' : 'error',
-            combined_submission: record,
-          })
-          callback(error, response)
-        }
-      )
-    }
+        )
+      }
 
-    this.originalGeneratePDF = this.generatePDF.bind(this)
-    this.generatePDF = function (templateId, _options, callback) {
-      // eslint-disable-next-line es5/no-es6-static-methods
-      var options = Object.assign({}, _options)
-      // Don't send timeout or wait options to the API - causes a schema validation error.
-      delete options.timeout
-      delete options.wait
+      this.originalGeneratePDF = this.generatePDF.bind(this)
+      this.generatePDF = function (templateId, _options, callback) {
+        // eslint-disable-next-line es5/no-es6-static-methods
+        var options = Object.assign({}, _options)
+        // Don't send timeout or wait options to the API - causes a schema validation error.
+        delete options.timeout
+        delete options.wait
 
-      waitForPDFJob(
-        _options,
-        function (waitCallback) {
-          self.originalGeneratePDF(templateId, options, function (
-            error,
-            response
-          ) {
-            if (error) {
-              callback(error, response)
-              return
-            }
-            waitCallback(response.submission)
-          })
-        },
-        function (record, updateCallback) {
-          self.getSubmission(record.id, {}, function (error, submission) {
+        waitForPDFJob(
+          _options,
+          function (waitCallback) {
+            self.originalGeneratePDF(
+              templateId,
+              options,
+              function (error, response) {
+                if (error) {
+                  callback(error, response)
+                  return
+                }
+                waitCallback(response.submission)
+              }
+            )
+          },
+          function (record, updateCallback) {
+            self.getSubmission(record.id, {}, function (error, submission) {
+              if (error) {
+                callback(error, submission)
+                return
+              }
+              updateCallback(submission)
+            })
+          },
+          function (error, record, success) {
             if (error) {
-              callback(error, submission)
+              callback(error, record)
               return
             }
-            updateCallback(submission)
-          })
-        },
-        function (error, record, success) {
-          if (error) {
-            callback(error, record)
-            return
+            var response = CreateSubmissionResponse.constructFromObject({
+              status: success ? 'success' : 'error',
+              submission: record,
+            })
+            callback(error, response)
           }
-          var response = CreateSubmissionResponse.constructFromObject({
-            status: success ? 'success' : 'error',
-            submission: record,
-          })
-          callback(error, response)
-        }
-      )
-    }
+        )
+      }
 
-    // this.batchGeneratePDF = function (templateId, createSubmissionData, callback) {
-    // };
-  }
+      // this.batchGeneratePDF = function (templateId, createSubmissionData, callback) {
+      // };
+    }
 
-  Client.prototype = Object.create(PDFApi.prototype)
-  Client.prototype.constructor = Client
+    Client.prototype = Object.create(PDFApi.prototype)
+    Client.prototype.constructor = Client
 
-  return Client
-})
+    return Client
+  }
+)

package/src/api/PDFApi.js

@@ -33,7 +33,7 @@
   /**
    * PDF service.
    * @module api/PDFApi
-   * @version 1.4.0
+   * @version 1.5.0
    */
 
   /**
@@ -680,6 +680,53 @@
       );
     }
 
+    /**
+     * Callback function to receive the result of the deleteTemplate operation.
+     * @callback module:api/PDFApi~deleteTemplateCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/UpdateTemplateResponse} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * Delete a template
+     * @param {String} templateId 
+     * @param {module:api/PDFApi~deleteTemplateCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/UpdateTemplateResponse}
+     */
+    this.deleteTemplate = function(templateId, callback) {
+      var postBody = null;
+
+      // verify the required parameter 'templateId' is set
+      if (templateId === undefined || templateId === null) {
+        throw new Error("Missing the required parameter 'templateId' when calling deleteTemplate");
+      }
+
+
+      var pathParams = {
+        'template_id': templateId
+      };
+      var queryParams = {
+      };
+      var collectionQueryParams = {
+      };
+      var headerParams = {
+      };
+      var formParams = {
+      };
+
+      var authNames = ['api_token_basic'];
+      var contentTypes = [];
+      var accepts = ['application/json'];
+      var returnType = UpdateTemplateResponse;
+
+      return this.apiClient.callApi(
+        '/templates/{template_id}', 'DELETE',
+        pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType, callback
+      );
+    }
+
     /**
      * Callback function to receive the result of the expireCombinedSubmission operation.
      * @callback module:api/PDFApi~expireCombinedSubmissionCallback
@@ -1204,6 +1251,52 @@
       );
     }
 
+    /**
+     * Callback function to receive the result of the listCombinedSubmissions operation.
+     * @callback module:api/PDFApi~listCombinedSubmissionsCallback
+     * @param {String} error Error message, if any.
+     * @param {Array.<module:model/CombinedSubmission>} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * Get a list of all combined submissions
+     * @param {Object} opts Optional parameters
+     * @param {Number} opts.page Default: 1
+     * @param {Number} opts.perPage Default: 50
+     * @param {module:api/PDFApi~listCombinedSubmissionsCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Array.<module:model/CombinedSubmission>}
+     */
+    this.listCombinedSubmissions = function(opts, callback) {
+      opts = opts || {};
+      var postBody = null;
+
+
+      var pathParams = {
+      };
+      var queryParams = {
+        'page': opts['page'],
+        'per_page': opts['perPage'],
+      };
+      var collectionQueryParams = {
+      };
+      var headerParams = {
+      };
+      var formParams = {
+      };
+
+      var authNames = ['api_token_basic'];
+      var contentTypes = [];
+      var accepts = ['application/json'];
+      var returnType = [CombinedSubmission];
+
+      return this.apiClient.callApi(
+        '/combined_submissions', 'GET',
+        pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType, callback
+      );
+    }
+
     /**
      * Callback function to receive the result of the listFolders operation.
      * @callback module:api/PDFApi~listFoldersCallback