docspring 1.3.0 → 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (83) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/LICENSE +1 -1
  3. package/README.md +10 -2
  4. package/docs/CombinePdfsData.md +1 -0
  5. package/docs/CombinedSubmission.md +1 -0
  6. package/docs/CombinedSubmissionData.md +1 -0
  7. package/docs/CopyTemplateData.md +9 -0
  8. package/docs/FullTemplate.md +59 -0
  9. package/docs/FullTemplateDefaults.md +10 -0
  10. package/docs/ListSubmissionsResponse.md +10 -0
  11. package/docs/MoveTemplateData.md +1 -1
  12. package/docs/PDFApi.md +223 -3
  13. package/docs/SubmissionData.md +1 -0
  14. package/docs/SubmissionDataRequest.md +1 -0
  15. package/docs/TemplatestemplateIdaddFieldsFields.md +1 -0
  16. package/package.json +1 -1
  17. package/src/ApiClient.js +1 -1
  18. package/src/api/PDFApi.js +221 -6
  19. package/src/index.js +24 -4
  20. package/src/model/AddFieldsData.js +1 -1
  21. package/src/model/AddFieldsTemplateResponse.js +1 -1
  22. package/src/model/AuthenticationError.js +1 -1
  23. package/src/model/AuthenticationSuccessResponse.js +1 -1
  24. package/src/model/CombinePdfsData.js +9 -1
  25. package/src/model/CombinedSubmission.js +9 -1
  26. package/src/model/CombinedSubmissionAction.js +1 -1
  27. package/src/model/CombinedSubmissionData.js +9 -1
  28. package/src/model/CopyTemplateData.js +90 -0
  29. package/src/model/CreateCombinedSubmissionResponse.js +1 -1
  30. package/src/model/CreateCustomFileData.js +1 -1
  31. package/src/model/CreateCustomFileResponse.js +1 -1
  32. package/src/model/CreateFolderData.js +1 -1
  33. package/src/model/CreateHtmlTemplateData.js +1 -1
  34. package/src/model/CreateSubmissionBatchResponse.js +1 -1
  35. package/src/model/CreateSubmissionBatchSubmissionsResponse.js +1 -1
  36. package/src/model/CreateSubmissionDataRequestData.js +1 -1
  37. package/src/model/CreateSubmissionDataRequestTokenResponse.js +1 -1
  38. package/src/model/CreateSubmissionDataRequestTokenResponseToken.js +1 -1
  39. package/src/model/CreateSubmissionResponse.js +1 -1
  40. package/src/model/CreateTemplateFromUploadData.js +1 -1
  41. package/src/model/CustomFile.js +1 -1
  42. package/src/model/Error.js +1 -1
  43. package/src/model/Folder.js +1 -1
  44. package/src/model/FoldersFolder.js +1 -1
  45. package/src/model/FullTemplate.js +407 -0
  46. package/src/model/FullTemplateDefaults.js +97 -0
  47. package/src/model/HtmlTemplateData.js +1 -1
  48. package/src/model/InvalidRequest.js +1 -1
  49. package/src/model/ListSubmissionsResponse.js +97 -0
  50. package/src/model/MoveFolderData.js +1 -1
  51. package/src/model/MoveTemplateData.js +4 -3
  52. package/src/model/PendingTemplate.js +1 -1
  53. package/src/model/RenameFolderData.js +1 -1
  54. package/src/model/Submission.js +1 -1
  55. package/src/model/SubmissionAction.js +1 -1
  56. package/src/model/SubmissionBatch.js +1 -1
  57. package/src/model/SubmissionBatchData.js +1 -1
  58. package/src/model/SubmissionData.js +9 -1
  59. package/src/model/SubmissionDataBatchRequest.js +1 -1
  60. package/src/model/SubmissionDataRequest.js +11 -2
  61. package/src/model/Template.js +1 -1
  62. package/src/model/TemplateData.js +1 -1
  63. package/src/model/TemplatestemplateIdaddFieldsFields.js +9 -1
  64. package/src/model/UpdateDataRequestResponse.js +1 -1
  65. package/src/model/UpdateSubmissionDataRequestData.js +1 -1
  66. package/src/model/UpdateTemplateData.js +1 -1
  67. package/src/model/UpdateTemplateResponse.js +1 -1
  68. package/src/model/UploadTemplateData.js +1 -1
  69. package/src/model/UploadTemplateDataDocument.js +1 -1
  70. package/src/model/UploadTemplateDataDocumentMetadata.js +1 -1
  71. package/test/api/ClientIntegration.spec.js +18 -2
  72. package/test/api/PDFApi.spec.js.original +40 -0
  73. package/test/model/CombinePdfsData.spec.js +6 -0
  74. package/test/model/CombinedSubmission.spec.js +6 -0
  75. package/test/model/CombinedSubmissionData.spec.js +6 -0
  76. package/test/model/CopyTemplateData.spec.js +73 -0
  77. package/test/model/FullTemplate.spec.js +295 -0
  78. package/test/model/FullTemplateDefaults.spec.js +79 -0
  79. package/test/model/ListSubmissionsResponse.spec.js +79 -0
  80. package/test/model/SubmissionData.spec.js +6 -0
  81. package/test/model/SubmissionDataRequest.spec.js +6 -0
  82. package/test/model/TemplatestemplateIdaddFieldsFields.spec.js +6 -0
  83. package/yarn.lock +263 -0
package/src/api/PDFApi.js CHANGED
@@ -16,24 +16,24 @@
16
16
  (function(root, factory) {
17
17
  if (typeof define === 'function' && define.amd) {
18
18
  // AMD. Register as an anonymous module.
19
- define(['../ApiClient', '../model/AddFieldsData', '../model/AddFieldsTemplateResponse', '../model/AuthenticationError', '../model/AuthenticationSuccessResponse', '../model/CombinePdfsData', '../model/CombinedSubmission', '../model/CombinedSubmissionData', '../model/CreateCombinedSubmissionResponse', '../model/CreateCustomFileData', '../model/CreateCustomFileResponse', '../model/CreateFolderData', '../model/CreateHtmlTemplateData', '../model/CreateSubmissionBatchResponse', '../model/CreateSubmissionDataRequestTokenResponse', '../model/CreateSubmissionResponse', '../model/CreateTemplateFromUploadData', '../model/Error', '../model/Folder', '../model/InvalidRequest', '../model/MoveFolderData', '../model/MoveTemplateData', '../model/PendingTemplate', '../model/RenameFolderData', '../model/Submission', '../model/SubmissionBatch', '../model/SubmissionBatchData', '../model/SubmissionData', '../model/SubmissionDataRequest', '../model/Template', '../model/UpdateDataRequestResponse', '../model/UpdateSubmissionDataRequestData', '../model/UpdateTemplateData', '../model/UpdateTemplateResponse'], factory);
19
+ define(['../ApiClient', '../model/AddFieldsData', '../model/AddFieldsTemplateResponse', '../model/AuthenticationError', '../model/AuthenticationSuccessResponse', '../model/CombinePdfsData', '../model/CombinedSubmission', '../model/CombinedSubmissionData', '../model/CopyTemplateData', '../model/CreateCombinedSubmissionResponse', '../model/CreateCustomFileData', '../model/CreateCustomFileResponse', '../model/CreateFolderData', '../model/CreateHtmlTemplateData', '../model/CreateSubmissionBatchResponse', '../model/CreateSubmissionDataRequestTokenResponse', '../model/CreateSubmissionResponse', '../model/CreateTemplateFromUploadData', '../model/Error', '../model/Folder', '../model/FullTemplate', '../model/InvalidRequest', '../model/ListSubmissionsResponse', '../model/MoveFolderData', '../model/MoveTemplateData', '../model/PendingTemplate', '../model/RenameFolderData', '../model/Submission', '../model/SubmissionBatch', '../model/SubmissionBatchData', '../model/SubmissionData', '../model/SubmissionDataRequest', '../model/Template', '../model/UpdateDataRequestResponse', '../model/UpdateSubmissionDataRequestData', '../model/UpdateTemplateData', '../model/UpdateTemplateResponse'], factory);
20
20
  } else if (typeof module === 'object' && module.exports) {
21
21
  // CommonJS-like environments that support module.exports, like Node.
22
- module.exports = factory(require('../ApiClient'), require('../model/AddFieldsData'), require('../model/AddFieldsTemplateResponse'), require('../model/AuthenticationError'), require('../model/AuthenticationSuccessResponse'), require('../model/CombinePdfsData'), require('../model/CombinedSubmission'), require('../model/CombinedSubmissionData'), require('../model/CreateCombinedSubmissionResponse'), require('../model/CreateCustomFileData'), require('../model/CreateCustomFileResponse'), require('../model/CreateFolderData'), require('../model/CreateHtmlTemplateData'), require('../model/CreateSubmissionBatchResponse'), require('../model/CreateSubmissionDataRequestTokenResponse'), require('../model/CreateSubmissionResponse'), require('../model/CreateTemplateFromUploadData'), require('../model/Error'), require('../model/Folder'), require('../model/InvalidRequest'), require('../model/MoveFolderData'), require('../model/MoveTemplateData'), require('../model/PendingTemplate'), require('../model/RenameFolderData'), require('../model/Submission'), require('../model/SubmissionBatch'), require('../model/SubmissionBatchData'), require('../model/SubmissionData'), require('../model/SubmissionDataRequest'), require('../model/Template'), require('../model/UpdateDataRequestResponse'), require('../model/UpdateSubmissionDataRequestData'), require('../model/UpdateTemplateData'), require('../model/UpdateTemplateResponse'));
22
+ module.exports = factory(require('../ApiClient'), require('../model/AddFieldsData'), require('../model/AddFieldsTemplateResponse'), require('../model/AuthenticationError'), require('../model/AuthenticationSuccessResponse'), require('../model/CombinePdfsData'), require('../model/CombinedSubmission'), require('../model/CombinedSubmissionData'), require('../model/CopyTemplateData'), require('../model/CreateCombinedSubmissionResponse'), require('../model/CreateCustomFileData'), require('../model/CreateCustomFileResponse'), require('../model/CreateFolderData'), require('../model/CreateHtmlTemplateData'), require('../model/CreateSubmissionBatchResponse'), require('../model/CreateSubmissionDataRequestTokenResponse'), require('../model/CreateSubmissionResponse'), require('../model/CreateTemplateFromUploadData'), require('../model/Error'), require('../model/Folder'), require('../model/FullTemplate'), require('../model/InvalidRequest'), require('../model/ListSubmissionsResponse'), require('../model/MoveFolderData'), require('../model/MoveTemplateData'), require('../model/PendingTemplate'), require('../model/RenameFolderData'), require('../model/Submission'), require('../model/SubmissionBatch'), require('../model/SubmissionBatchData'), require('../model/SubmissionData'), require('../model/SubmissionDataRequest'), require('../model/Template'), require('../model/UpdateDataRequestResponse'), require('../model/UpdateSubmissionDataRequestData'), require('../model/UpdateTemplateData'), require('../model/UpdateTemplateResponse'));
23
23
  } else {
24
24
  // Browser globals (root is window)
25
25
  if (!root.DocSpring) {
26
26
  root.DocSpring = {};
27
27
  }
28
- root.DocSpring.PDFApi = factory(root.DocSpring.ApiClient, root.DocSpring.AddFieldsData, root.DocSpring.AddFieldsTemplateResponse, root.DocSpring.AuthenticationError, root.DocSpring.AuthenticationSuccessResponse, root.DocSpring.CombinePdfsData, root.DocSpring.CombinedSubmission, root.DocSpring.CombinedSubmissionData, root.DocSpring.CreateCombinedSubmissionResponse, root.DocSpring.CreateCustomFileData, root.DocSpring.CreateCustomFileResponse, root.DocSpring.CreateFolderData, root.DocSpring.CreateHtmlTemplateData, root.DocSpring.CreateSubmissionBatchResponse, root.DocSpring.CreateSubmissionDataRequestTokenResponse, root.DocSpring.CreateSubmissionResponse, root.DocSpring.CreateTemplateFromUploadData, root.DocSpring.Error, root.DocSpring.Folder, root.DocSpring.InvalidRequest, root.DocSpring.MoveFolderData, root.DocSpring.MoveTemplateData, root.DocSpring.PendingTemplate, root.DocSpring.RenameFolderData, root.DocSpring.Submission, root.DocSpring.SubmissionBatch, root.DocSpring.SubmissionBatchData, root.DocSpring.SubmissionData, root.DocSpring.SubmissionDataRequest, root.DocSpring.Template, root.DocSpring.UpdateDataRequestResponse, root.DocSpring.UpdateSubmissionDataRequestData, root.DocSpring.UpdateTemplateData, root.DocSpring.UpdateTemplateResponse);
28
+ root.DocSpring.PDFApi = factory(root.DocSpring.ApiClient, root.DocSpring.AddFieldsData, root.DocSpring.AddFieldsTemplateResponse, root.DocSpring.AuthenticationError, root.DocSpring.AuthenticationSuccessResponse, root.DocSpring.CombinePdfsData, root.DocSpring.CombinedSubmission, root.DocSpring.CombinedSubmissionData, root.DocSpring.CopyTemplateData, root.DocSpring.CreateCombinedSubmissionResponse, root.DocSpring.CreateCustomFileData, root.DocSpring.CreateCustomFileResponse, root.DocSpring.CreateFolderData, root.DocSpring.CreateHtmlTemplateData, root.DocSpring.CreateSubmissionBatchResponse, root.DocSpring.CreateSubmissionDataRequestTokenResponse, root.DocSpring.CreateSubmissionResponse, root.DocSpring.CreateTemplateFromUploadData, root.DocSpring.Error, root.DocSpring.Folder, root.DocSpring.FullTemplate, root.DocSpring.InvalidRequest, root.DocSpring.ListSubmissionsResponse, root.DocSpring.MoveFolderData, root.DocSpring.MoveTemplateData, root.DocSpring.PendingTemplate, root.DocSpring.RenameFolderData, root.DocSpring.Submission, root.DocSpring.SubmissionBatch, root.DocSpring.SubmissionBatchData, root.DocSpring.SubmissionData, root.DocSpring.SubmissionDataRequest, root.DocSpring.Template, root.DocSpring.UpdateDataRequestResponse, root.DocSpring.UpdateSubmissionDataRequestData, root.DocSpring.UpdateTemplateData, root.DocSpring.UpdateTemplateResponse);
29
29
  }
30
- }(this, function(ApiClient, AddFieldsData, AddFieldsTemplateResponse, AuthenticationError, AuthenticationSuccessResponse, CombinePdfsData, CombinedSubmission, CombinedSubmissionData, CreateCombinedSubmissionResponse, CreateCustomFileData, CreateCustomFileResponse, CreateFolderData, CreateHtmlTemplateData, CreateSubmissionBatchResponse, CreateSubmissionDataRequestTokenResponse, CreateSubmissionResponse, CreateTemplateFromUploadData, Error, Folder, InvalidRequest, MoveFolderData, MoveTemplateData, PendingTemplate, RenameFolderData, Submission, SubmissionBatch, SubmissionBatchData, SubmissionData, SubmissionDataRequest, Template, UpdateDataRequestResponse, UpdateSubmissionDataRequestData, UpdateTemplateData, UpdateTemplateResponse) {
30
+ }(this, function(ApiClient, AddFieldsData, AddFieldsTemplateResponse, AuthenticationError, AuthenticationSuccessResponse, CombinePdfsData, CombinedSubmission, CombinedSubmissionData, CopyTemplateData, CreateCombinedSubmissionResponse, CreateCustomFileData, CreateCustomFileResponse, CreateFolderData, CreateHtmlTemplateData, CreateSubmissionBatchResponse, CreateSubmissionDataRequestTokenResponse, CreateSubmissionResponse, CreateTemplateFromUploadData, Error, Folder, FullTemplate, InvalidRequest, ListSubmissionsResponse, MoveFolderData, MoveTemplateData, PendingTemplate, RenameFolderData, Submission, SubmissionBatch, SubmissionBatchData, SubmissionData, SubmissionDataRequest, Template, UpdateDataRequestResponse, UpdateSubmissionDataRequestData, UpdateTemplateData, UpdateTemplateResponse) {
31
31
  'use strict';
32
32
 
33
33
  /**
34
34
  * PDF service.
35
35
  * @module api/PDFApi
36
- * @version 1.3.0
36
+ * @version 1.4.0
37
37
  */
38
38
 
39
39
  /**
@@ -291,6 +291,59 @@
291
291
  );
292
292
  }
293
293
 
294
+ /**
295
+ * Callback function to receive the result of the copyTemplate operation.
296
+ * @callback module:api/PDFApi~copyTemplateCallback
297
+ * @param {String} error Error message, if any.
298
+ * @param {module:model/Template} data The data returned by the service call.
299
+ * @param {String} response The complete HTTP response.
300
+ */
301
+
302
+ /**
303
+ * Copy a Template
304
+ * @param {String} templateId
305
+ * @param {module:model/CopyTemplateData} copyTemplateData
306
+ * @param {module:api/PDFApi~copyTemplateCallback} callback The callback function, accepting three arguments: error, data, response
307
+ * data is of type: {@link module:model/Template}
308
+ */
309
+ this.copyTemplate = function(templateId, copyTemplateData, callback) {
310
+ var postBody = copyTemplateData;
311
+
312
+ // verify the required parameter 'templateId' is set
313
+ if (templateId === undefined || templateId === null) {
314
+ throw new Error("Missing the required parameter 'templateId' when calling copyTemplate");
315
+ }
316
+
317
+ // verify the required parameter 'copyTemplateData' is set
318
+ if (copyTemplateData === undefined || copyTemplateData === null) {
319
+ throw new Error("Missing the required parameter 'copyTemplateData' when calling copyTemplate");
320
+ }
321
+
322
+
323
+ var pathParams = {
324
+ 'template_id': templateId
325
+ };
326
+ var queryParams = {
327
+ };
328
+ var collectionQueryParams = {
329
+ };
330
+ var headerParams = {
331
+ };
332
+ var formParams = {
333
+ };
334
+
335
+ var authNames = ['api_token_basic'];
336
+ var contentTypes = ['application/json'];
337
+ var accepts = ['application/json'];
338
+ var returnType = Template;
339
+
340
+ return this.apiClient.callApi(
341
+ '/templates/{template_id}/copy', 'POST',
342
+ pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
343
+ authNames, contentTypes, accepts, returnType, callback
344
+ );
345
+ }
346
+
294
347
  /**
295
348
  * Callback function to receive the result of the createCustomFileFromUpload operation.
296
349
  * @callback module:api/PDFApi~createCustomFileFromUploadCallback
@@ -868,6 +921,53 @@
868
921
  );
869
922
  }
870
923
 
924
+ /**
925
+ * Callback function to receive the result of the getFullTemplate operation.
926
+ * @callback module:api/PDFApi~getFullTemplateCallback
927
+ * @param {String} error Error message, if any.
928
+ * @param {module:model/FullTemplate} data The data returned by the service call.
929
+ * @param {String} response The complete HTTP response.
930
+ */
931
+
932
+ /**
933
+ * Fetch the full template attributes
934
+ * @param {String} templateId
935
+ * @param {module:api/PDFApi~getFullTemplateCallback} callback The callback function, accepting three arguments: error, data, response
936
+ * data is of type: {@link module:model/FullTemplate}
937
+ */
938
+ this.getFullTemplate = function(templateId, callback) {
939
+ var postBody = null;
940
+
941
+ // verify the required parameter 'templateId' is set
942
+ if (templateId === undefined || templateId === null) {
943
+ throw new Error("Missing the required parameter 'templateId' when calling getFullTemplate");
944
+ }
945
+
946
+
947
+ var pathParams = {
948
+ 'template_id': templateId
949
+ };
950
+ var queryParams = {
951
+ };
952
+ var collectionQueryParams = {
953
+ };
954
+ var headerParams = {
955
+ };
956
+ var formParams = {
957
+ };
958
+
959
+ var authNames = ['api_token_basic'];
960
+ var contentTypes = [];
961
+ var accepts = ['application/json'];
962
+ var returnType = FullTemplate;
963
+
964
+ return this.apiClient.callApi(
965
+ '/templates/{template_id}?full=true', 'GET',
966
+ pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
967
+ authNames, contentTypes, accepts, returnType, callback
968
+ );
969
+ }
970
+
871
971
  /**
872
972
  * Callback function to receive the result of the getPresignUrl operation.
873
973
  * @callback module:api/PDFApi~getPresignUrlCallback
@@ -1019,7 +1119,7 @@
1019
1119
  */
1020
1120
 
1021
1121
  /**
1022
- * Get a single template
1122
+ * Check the status of an uploaded template
1023
1123
  * @param {String} templateId
1024
1124
  * @param {module:api/PDFApi~getTemplateCallback} callback The callback function, accepting three arguments: error, data, response
1025
1125
  * data is of type: {@link module:model/Template}
@@ -1148,6 +1248,121 @@
1148
1248
  );
1149
1249
  }
1150
1250
 
1251
+ /**
1252
+ * Callback function to receive the result of the listSubmissions operation.
1253
+ * @callback module:api/PDFApi~listSubmissionsCallback
1254
+ * @param {String} error Error message, if any.
1255
+ * @param {module:model/ListSubmissionsResponse} data The data returned by the service call.
1256
+ * @param {String} response The complete HTTP response.
1257
+ */
1258
+
1259
+ /**
1260
+ * List all submissions
1261
+ * @param {Object} opts Optional parameters
1262
+ * @param {String} opts.cursor
1263
+ * @param {Number} opts.limit
1264
+ * @param {String} opts.createdAfter
1265
+ * @param {String} opts.createdBefore
1266
+ * @param {String} opts.type
1267
+ * @param {Boolean} opts.includeData
1268
+ * @param {module:api/PDFApi~listSubmissionsCallback} callback The callback function, accepting three arguments: error, data, response
1269
+ * data is of type: {@link module:model/ListSubmissionsResponse}
1270
+ */
1271
+ this.listSubmissions = function(opts, callback) {
1272
+ opts = opts || {};
1273
+ var postBody = null;
1274
+
1275
+
1276
+ var pathParams = {
1277
+ };
1278
+ var queryParams = {
1279
+ 'cursor': opts['cursor'],
1280
+ 'limit': opts['limit'],
1281
+ 'created_after': opts['createdAfter'],
1282
+ 'created_before': opts['createdBefore'],
1283
+ 'type': opts['type'],
1284
+ 'include_data': opts['includeData'],
1285
+ };
1286
+ var collectionQueryParams = {
1287
+ };
1288
+ var headerParams = {
1289
+ };
1290
+ var formParams = {
1291
+ };
1292
+
1293
+ var authNames = ['api_token_basic'];
1294
+ var contentTypes = [];
1295
+ var accepts = ['application/json'];
1296
+ var returnType = ListSubmissionsResponse;
1297
+
1298
+ return this.apiClient.callApi(
1299
+ '/submissions', 'GET',
1300
+ pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
1301
+ authNames, contentTypes, accepts, returnType, callback
1302
+ );
1303
+ }
1304
+
1305
+ /**
1306
+ * Callback function to receive the result of the listSubmissions_0 operation.
1307
+ * @callback module:api/PDFApi~listSubmissions_0Callback
1308
+ * @param {String} error Error message, if any.
1309
+ * @param {module:model/ListSubmissionsResponse} data The data returned by the service call.
1310
+ * @param {String} response The complete HTTP response.
1311
+ */
1312
+
1313
+ /**
1314
+ * List all submissions for a given template
1315
+ * @param {String} templateId
1316
+ * @param {Object} opts Optional parameters
1317
+ * @param {String} opts.cursor
1318
+ * @param {Number} opts.limit
1319
+ * @param {String} opts.createdAfter
1320
+ * @param {String} opts.createdBefore
1321
+ * @param {String} opts.type
1322
+ * @param {Boolean} opts.includeData
1323
+ * @param {module:api/PDFApi~listSubmissions_0Callback} callback The callback function, accepting three arguments: error, data, response
1324
+ * data is of type: {@link module:model/ListSubmissionsResponse}
1325
+ */
1326
+ this.listSubmissions_0 = function(templateId, opts, callback) {
1327
+ opts = opts || {};
1328
+ var postBody = null;
1329
+
1330
+ // verify the required parameter 'templateId' is set
1331
+ if (templateId === undefined || templateId === null) {
1332
+ throw new Error("Missing the required parameter 'templateId' when calling listSubmissions_0");
1333
+ }
1334
+
1335
+
1336
+ var pathParams = {
1337
+ 'template_id': templateId
1338
+ };
1339
+ var queryParams = {
1340
+ 'cursor': opts['cursor'],
1341
+ 'limit': opts['limit'],
1342
+ 'created_after': opts['createdAfter'],
1343
+ 'created_before': opts['createdBefore'],
1344
+ 'type': opts['type'],
1345
+ 'include_data': opts['includeData'],
1346
+ };
1347
+ var collectionQueryParams = {
1348
+ };
1349
+ var headerParams = {
1350
+ };
1351
+ var formParams = {
1352
+ };
1353
+
1354
+ var authNames = ['api_token_basic'];
1355
+ var contentTypes = [];
1356
+ var accepts = ['application/json'];
1357
+ var returnType = ListSubmissionsResponse;
1358
+
1359
+ return this.apiClient.callApi(
1360
+ '/templates/{template_id}/submissions', 'GET',
1361
+ pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
1362
+ authNames, contentTypes, accepts, returnType, callback
1363
+ );
1364
+ }
1365
+
1151
1366
  /**
1152
1367
  * Callback function to receive the result of the listTemplates operation.
1153
1368
  * @callback module:api/PDFApi~listTemplatesCallback
package/src/index.js CHANGED
@@ -16,12 +16,12 @@
16
16
  (function(factory) {
17
17
  if (typeof define === 'function' && define.amd) {
18
18
  // AMD. Register as an anonymous module.
19
- define(['./ApiClient', './api/Client', './model/AddFieldsData', './model/AddFieldsTemplateResponse', './model/AuthenticationError', './model/AuthenticationSuccessResponse', './model/CombinePdfsData', './model/CombinedSubmission', './model/CombinedSubmissionAction', './model/CombinedSubmissionData', './model/CreateCombinedSubmissionResponse', './model/CreateCustomFileData', './model/CreateCustomFileResponse', './model/CreateFolderData', './model/CreateHtmlTemplateData', './model/CreateSubmissionBatchResponse', './model/CreateSubmissionBatchSubmissionsResponse', './model/CreateSubmissionDataRequestData', './model/CreateSubmissionDataRequestTokenResponse', './model/CreateSubmissionDataRequestTokenResponseToken', './model/CreateSubmissionResponse', './model/CreateTemplateFromUploadData', './model/CustomFile', './model/Error', './model/Folder', './model/FoldersFolder', './model/HtmlTemplateData', './model/InvalidRequest', './model/MoveFolderData', './model/MoveTemplateData', './model/PendingTemplate', './model/RenameFolderData', './model/Submission', './model/SubmissionAction', './model/SubmissionBatch', './model/SubmissionBatchData', './model/SubmissionData', './model/SubmissionDataBatchRequest', './model/SubmissionDataRequest', './model/Template', './model/TemplateData', './model/TemplatestemplateIdaddFieldsFields', './model/UpdateDataRequestResponse', './model/UpdateSubmissionDataRequestData', './model/UpdateTemplateData', './model/UpdateTemplateResponse', './model/UploadTemplateData', './model/UploadTemplateDataDocument', './model/UploadTemplateDataDocumentMetadata', './api/PDFApi'], factory);
19
+ define(['./ApiClient', './api/Client', './model/AddFieldsData', './model/AddFieldsTemplateResponse', './model/AuthenticationError', './model/AuthenticationSuccessResponse', './model/CombinePdfsData', './model/CombinedSubmission', './model/CombinedSubmissionAction', './model/CombinedSubmissionData', './model/CopyTemplateData', './model/CreateCombinedSubmissionResponse', './model/CreateCustomFileData', './model/CreateCustomFileResponse', './model/CreateFolderData', './model/CreateHtmlTemplateData', './model/CreateSubmissionBatchResponse', './model/CreateSubmissionBatchSubmissionsResponse', './model/CreateSubmissionDataRequestData', './model/CreateSubmissionDataRequestTokenResponse', './model/CreateSubmissionDataRequestTokenResponseToken', './model/CreateSubmissionResponse', './model/CreateTemplateFromUploadData', './model/CustomFile', './model/Error', './model/Folder', './model/FoldersFolder', './model/FullTemplate', './model/FullTemplateDefaults', './model/HtmlTemplateData', './model/InvalidRequest', './model/ListSubmissionsResponse', './model/MoveFolderData', './model/MoveTemplateData', './model/PendingTemplate', './model/RenameFolderData', './model/Submission', './model/SubmissionAction', './model/SubmissionBatch', './model/SubmissionBatchData', './model/SubmissionData', './model/SubmissionDataBatchRequest', './model/SubmissionDataRequest', './model/Template', './model/TemplateData', './model/TemplatestemplateIdaddFieldsFields', './model/UpdateDataRequestResponse', './model/UpdateSubmissionDataRequestData', './model/UpdateTemplateData', './model/UpdateTemplateResponse', './model/UploadTemplateData', './model/UploadTemplateDataDocument', './model/UploadTemplateDataDocumentMetadata', './api/PDFApi'], factory);
20
20
  } else if (typeof module === 'object' && module.exports) {
21
21
  // CommonJS-like environments that support module.exports, like Node.
22
- module.exports = factory(require('./ApiClient'), require('./api/Client'), require('./model/AddFieldsData'), require('./model/AddFieldsTemplateResponse'), require('./model/AuthenticationError'), require('./model/AuthenticationSuccessResponse'), require('./model/CombinePdfsData'), require('./model/CombinedSubmission'), require('./model/CombinedSubmissionAction'), require('./model/CombinedSubmissionData'), require('./model/CreateCombinedSubmissionResponse'), require('./model/CreateCustomFileData'), require('./model/CreateCustomFileResponse'), require('./model/CreateFolderData'), require('./model/CreateHtmlTemplateData'), require('./model/CreateSubmissionBatchResponse'), require('./model/CreateSubmissionBatchSubmissionsResponse'), require('./model/CreateSubmissionDataRequestData'), require('./model/CreateSubmissionDataRequestTokenResponse'), require('./model/CreateSubmissionDataRequestTokenResponseToken'), require('./model/CreateSubmissionResponse'), require('./model/CreateTemplateFromUploadData'), require('./model/CustomFile'), require('./model/Error'), require('./model/Folder'), require('./model/FoldersFolder'), require('./model/HtmlTemplateData'), require('./model/InvalidRequest'), require('./model/MoveFolderData'), require('./model/MoveTemplateData'), require('./model/PendingTemplate'), require('./model/RenameFolderData'), require('./model/Submission'), require('./model/SubmissionAction'), require('./model/SubmissionBatch'), require('./model/SubmissionBatchData'), require('./model/SubmissionData'), require('./model/SubmissionDataBatchRequest'), require('./model/SubmissionDataRequest'), require('./model/Template'), require('./model/TemplateData'), require('./model/TemplatestemplateIdaddFieldsFields'), require('./model/UpdateDataRequestResponse'), require('./model/UpdateSubmissionDataRequestData'), require('./model/UpdateTemplateData'), require('./model/UpdateTemplateResponse'), require('./model/UploadTemplateData'), require('./model/UploadTemplateDataDocument'), require('./model/UploadTemplateDataDocumentMetadata'), require('./api/PDFApi'));
22
+ module.exports = factory(require('./ApiClient'), require('./api/Client'), require('./model/AddFieldsData'), require('./model/AddFieldsTemplateResponse'), require('./model/AuthenticationError'), require('./model/AuthenticationSuccessResponse'), require('./model/CombinePdfsData'), require('./model/CombinedSubmission'), require('./model/CombinedSubmissionAction'), require('./model/CombinedSubmissionData'), require('./model/CopyTemplateData'), require('./model/CreateCombinedSubmissionResponse'), require('./model/CreateCustomFileData'), require('./model/CreateCustomFileResponse'), require('./model/CreateFolderData'), require('./model/CreateHtmlTemplateData'), require('./model/CreateSubmissionBatchResponse'), require('./model/CreateSubmissionBatchSubmissionsResponse'), require('./model/CreateSubmissionDataRequestData'), require('./model/CreateSubmissionDataRequestTokenResponse'), require('./model/CreateSubmissionDataRequestTokenResponseToken'), require('./model/CreateSubmissionResponse'), require('./model/CreateTemplateFromUploadData'), require('./model/CustomFile'), require('./model/Error'), require('./model/Folder'), require('./model/FoldersFolder'), require('./model/FullTemplate'), require('./model/FullTemplateDefaults'), require('./model/HtmlTemplateData'), require('./model/InvalidRequest'), require('./model/ListSubmissionsResponse'), require('./model/MoveFolderData'), require('./model/MoveTemplateData'), require('./model/PendingTemplate'), require('./model/RenameFolderData'), require('./model/Submission'), require('./model/SubmissionAction'), require('./model/SubmissionBatch'), require('./model/SubmissionBatchData'), require('./model/SubmissionData'), require('./model/SubmissionDataBatchRequest'), require('./model/SubmissionDataRequest'), require('./model/Template'), require('./model/TemplateData'), require('./model/TemplatestemplateIdaddFieldsFields'), require('./model/UpdateDataRequestResponse'), require('./model/UpdateSubmissionDataRequestData'), require('./model/UpdateTemplateData'), require('./model/UpdateTemplateResponse'), require('./model/UploadTemplateData'), require('./model/UploadTemplateDataDocument'), require('./model/UploadTemplateDataDocumentMetadata'), require('./api/PDFApi'));
23
23
  }
24
- }(function(ApiClient, Client, AddFieldsData, AddFieldsTemplateResponse, AuthenticationError, AuthenticationSuccessResponse, CombinePdfsData, CombinedSubmission, CombinedSubmissionAction, CombinedSubmissionData, CreateCombinedSubmissionResponse, CreateCustomFileData, CreateCustomFileResponse, CreateFolderData, CreateHtmlTemplateData, CreateSubmissionBatchResponse, CreateSubmissionBatchSubmissionsResponse, CreateSubmissionDataRequestData, CreateSubmissionDataRequestTokenResponse, CreateSubmissionDataRequestTokenResponseToken, CreateSubmissionResponse, CreateTemplateFromUploadData, CustomFile, Error, Folder, FoldersFolder, HtmlTemplateData, InvalidRequest, MoveFolderData, MoveTemplateData, PendingTemplate, RenameFolderData, Submission, SubmissionAction, SubmissionBatch, SubmissionBatchData, SubmissionData, SubmissionDataBatchRequest, SubmissionDataRequest, Template, TemplateData, TemplatestemplateIdaddFieldsFields, UpdateDataRequestResponse, UpdateSubmissionDataRequestData, UpdateTemplateData, UpdateTemplateResponse, UploadTemplateData, UploadTemplateDataDocument, UploadTemplateDataDocumentMetadata, PDFApi) {
24
+ }(function(ApiClient, Client, AddFieldsData, AddFieldsTemplateResponse, AuthenticationError, AuthenticationSuccessResponse, CombinePdfsData, CombinedSubmission, CombinedSubmissionAction, CombinedSubmissionData, CopyTemplateData, CreateCombinedSubmissionResponse, CreateCustomFileData, CreateCustomFileResponse, CreateFolderData, CreateHtmlTemplateData, CreateSubmissionBatchResponse, CreateSubmissionBatchSubmissionsResponse, CreateSubmissionDataRequestData, CreateSubmissionDataRequestTokenResponse, CreateSubmissionDataRequestTokenResponseToken, CreateSubmissionResponse, CreateTemplateFromUploadData, CustomFile, Error, Folder, FoldersFolder, FullTemplate, FullTemplateDefaults, HtmlTemplateData, InvalidRequest, ListSubmissionsResponse, MoveFolderData, MoveTemplateData, PendingTemplate, RenameFolderData, Submission, SubmissionAction, SubmissionBatch, SubmissionBatchData, SubmissionData, SubmissionDataBatchRequest, SubmissionDataRequest, Template, TemplateData, TemplatestemplateIdaddFieldsFields, UpdateDataRequestResponse, UpdateSubmissionDataRequestData, UpdateTemplateData, UpdateTemplateResponse, UploadTemplateData, UploadTemplateDataDocument, UploadTemplateDataDocumentMetadata, PDFApi) {
25
25
  'use strict';
26
26
 
27
27
  /**
@@ -53,7 +53,7 @@
53
53
  * </pre>
54
54
  * </p>
55
55
  * @module index
56
- * @version 1.3.0
56
+ * @version 1.4.0
57
57
  */
58
58
  var exports = {
59
59
  /**
@@ -108,6 +108,11 @@
108
108
  * @property {module:model/CombinedSubmissionData}
109
109
  */
110
110
  CombinedSubmissionData: CombinedSubmissionData,
111
+ /**
112
+ * The CopyTemplateData model constructor.
113
+ * @property {module:model/CopyTemplateData}
114
+ */
115
+ CopyTemplateData: CopyTemplateData,
111
116
  /**
112
117
  * The CreateCombinedSubmissionResponse model constructor.
113
118
  * @property {module:model/CreateCombinedSubmissionResponse}
@@ -188,6 +193,16 @@
188
193
  * @property {module:model/FoldersFolder}
189
194
  */
190
195
  FoldersFolder: FoldersFolder,
196
+ /**
197
+ * The FullTemplate model constructor.
198
+ * @property {module:model/FullTemplate}
199
+ */
200
+ FullTemplate: FullTemplate,
201
+ /**
202
+ * The FullTemplateDefaults model constructor.
203
+ * @property {module:model/FullTemplateDefaults}
204
+ */
205
+ FullTemplateDefaults: FullTemplateDefaults,
191
206
  /**
192
207
  * The HtmlTemplateData model constructor.
193
208
  * @property {module:model/HtmlTemplateData}
@@ -198,6 +213,11 @@
198
213
  * @property {module:model/InvalidRequest}
199
214
  */
200
215
  InvalidRequest: InvalidRequest,
216
+ /**
217
+ * The ListSubmissionsResponse model constructor.
218
+ * @property {module:model/ListSubmissionsResponse}
219
+ */
220
+ ListSubmissionsResponse: ListSubmissionsResponse,
201
221
  /**
202
222
  * The MoveFolderData model constructor.
203
223
  * @property {module:model/MoveFolderData}
@@ -36,7 +36,7 @@
36
36
  /**
37
37
  * The AddFieldsData model module.
38
38
  * @module model/AddFieldsData
39
- * @version 1.3.0
39
+ * @version 1.4.0
40
40
  */
41
41
 
42
42
  /**
@@ -36,7 +36,7 @@
36
36
  /**
37
37
  * The AddFieldsTemplateResponse model module.
38
38
  * @module model/AddFieldsTemplateResponse
39
- * @version 1.3.0
39
+ * @version 1.4.0
40
40
  */
41
41
 
42
42
  /**
@@ -36,7 +36,7 @@
36
36
  /**
37
37
  * The AuthenticationError model module.
38
38
  * @module model/AuthenticationError
39
- * @version 1.3.0
39
+ * @version 1.4.0
40
40
  */
41
41
 
42
42
  /**
@@ -36,7 +36,7 @@
36
36
  /**
37
37
  * The AuthenticationSuccessResponse model module.
38
38
  * @module model/AuthenticationSuccessResponse
39
- * @version 1.3.0
39
+ * @version 1.4.0
40
40
  */
41
41
 
42
42
  /**
@@ -36,7 +36,7 @@
36
36
  /**
37
37
  * The CombinePdfsData model module.
38
38
  * @module model/CombinePdfsData
39
- * @version 1.3.0
39
+ * @version 1.4.0
40
40
  */
41
41
 
42
42
  /**
@@ -51,6 +51,7 @@
51
51
 
52
52
 
53
53
 
54
+
54
55
  _this['source_pdfs'] = sourcePdfs;
55
56
 
56
57
  };
@@ -75,6 +76,9 @@
75
76
  if (data.hasOwnProperty('metadata')) {
76
77
  obj['metadata'] = ApiClient.convertToType(data['metadata'], Object);
77
78
  }
79
+ if (data.hasOwnProperty('password')) {
80
+ obj['password'] = ApiClient.convertToType(data['password'], 'String');
81
+ }
78
82
  if (data.hasOwnProperty('source_pdfs')) {
79
83
  obj['source_pdfs'] = ApiClient.convertToType(data['source_pdfs'], [Object]);
80
84
  }
@@ -97,6 +101,10 @@
97
101
  * @member {Object} metadata
98
102
  */
99
103
  exports.prototype['metadata'] = undefined;
104
+ /**
105
+ * @member {String} password
106
+ */
107
+ exports.prototype['password'] = undefined;
100
108
  /**
101
109
  * @member {Array.<Object>} source_pdfs
102
110
  */
@@ -36,7 +36,7 @@
36
36
  /**
37
37
  * The CombinedSubmission model module.
38
38
  * @module model/CombinedSubmission
39
- * @version 1.3.0
39
+ * @version 1.4.0
40
40
  */
41
41
 
42
42
  /**
@@ -57,6 +57,7 @@
57
57
 
58
58
 
59
59
 
60
+
60
61
  };
61
62
 
62
63
  /**
@@ -73,6 +74,9 @@
73
74
  if (data.hasOwnProperty('metadata')) {
74
75
  obj['metadata'] = ApiClient.convertToType(data['metadata'], Object);
75
76
  }
77
+ if (data.hasOwnProperty('password')) {
78
+ obj['password'] = ApiClient.convertToType(data['password'], 'String');
79
+ }
76
80
  if (data.hasOwnProperty('expired')) {
77
81
  obj['expired'] = ApiClient.convertToType(data['expired'], 'Boolean');
78
82
  }
@@ -108,6 +112,10 @@
108
112
  * @member {Object} metadata
109
113
  */
110
114
  exports.prototype['metadata'] = undefined;
115
+ /**
116
+ * @member {String} password
117
+ */
118
+ exports.prototype['password'] = undefined;
111
119
  /**
112
120
  * @member {Boolean} expired
113
121
  */
@@ -36,7 +36,7 @@
36
36
  /**
37
37
  * The CombinedSubmissionAction model module.
38
38
  * @module model/CombinedSubmissionAction
39
- * @version 1.3.0
39
+ * @version 1.4.0
40
40
  */
41
41
 
42
42
  /**
@@ -36,7 +36,7 @@
36
36
  /**
37
37
  * The CombinedSubmissionData model module.
38
38
  * @module model/CombinedSubmissionData
39
- * @version 1.3.0
39
+ * @version 1.4.0
40
40
  */
41
41
 
42
42
  /**
@@ -50,6 +50,7 @@
50
50
 
51
51
 
52
52
 
53
+
53
54
  _this['submission_ids'] = submissionIds;
54
55
 
55
56
  };
@@ -71,6 +72,9 @@
71
72
  if (data.hasOwnProperty('metadata')) {
72
73
  obj['metadata'] = ApiClient.convertToType(data['metadata'], Object);
73
74
  }
75
+ if (data.hasOwnProperty('password')) {
76
+ obj['password'] = ApiClient.convertToType(data['password'], 'String');
77
+ }
74
78
  if (data.hasOwnProperty('submission_ids')) {
75
79
  obj['submission_ids'] = ApiClient.convertToType(data['submission_ids'], ['String']);
76
80
  }
@@ -89,6 +93,10 @@
89
93
  * @member {Object} metadata
90
94
  */
91
95
  exports.prototype['metadata'] = undefined;
96
+ /**
97
+ * @member {String} password
98
+ */
99
+ exports.prototype['password'] = undefined;
92
100
  /**
93
101
  * @member {Array.<String>} submission_ids
94
102
  */
@@ -0,0 +1,90 @@
1
+ /**
2
+ * API v1
3
+ * DocSpring is a service that helps you fill out and sign PDF templates.
4
+ *
5
+ * OpenAPI spec version: v1
6
+ *
7
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
8
+ * https://openapi-generator.tech
9
+ *
10
+ * OpenAPI Generator version: 3.3.0
11
+ *
12
+ * Do not edit the class manually.
13
+ *
14
+ */
15
+
16
+ (function(root, factory) {
17
+ if (typeof define === 'function' && define.amd) {
18
+ // AMD. Register as an anonymous module.
19
+ define(['../ApiClient'], factory);
20
+ } else if (typeof module === 'object' && module.exports) {
21
+ // CommonJS-like environments that support module.exports, like Node.
22
+ module.exports = factory(require('../ApiClient'));
23
+ } else {
24
+ // Browser globals (root is window)
25
+ if (!root.DocSpring) {
26
+ root.DocSpring = {};
27
+ }
28
+ root.DocSpring.CopyTemplateData = factory(root.DocSpring.ApiClient);
29
+ }
30
+ }(this, function(ApiClient) {
31
+ 'use strict';
32
+
33
+
34
+
35
+
36
+ /**
37
+ * The CopyTemplateData model module.
38
+ * @module model/CopyTemplateData
39
+ * @version 1.4.0
40
+ */
41
+
42
+ /**
43
+ * Constructs a new <code>CopyTemplateData</code>.
44
+ * @alias module:model/CopyTemplateData
45
+ * @class
46
+ * @param parentFolderId {String}
47
+ */
48
+ var exports = function(parentFolderId) {
49
+ var _this = this;
50
+
51
+
52
+ _this['parent_folder_id'] = parentFolderId;
53
+ };
54
+
55
+ /**
56
+ * Constructs a <code>CopyTemplateData</code> from a plain JavaScript object, optionally creating a new instance.
57
+ * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
58
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
59
+ * @param {module:model/CopyTemplateData} obj Optional instance to populate.
60
+ * @return {module:model/CopyTemplateData} The populated <code>CopyTemplateData</code> instance.
61
+ */
62
+ exports.constructFromObject = function(data, obj) {
63
+ if (data) {
64
+ obj = obj || new exports();
65
+
66
+ if (data.hasOwnProperty('name')) {
67
+ obj['name'] = ApiClient.convertToType(data['name'], 'String');
68
+ }
69
+ if (data.hasOwnProperty('parent_folder_id')) {
70
+ obj['parent_folder_id'] = ApiClient.convertToType(data['parent_folder_id'], 'String');
71
+ }
72
+ }
73
+ return obj;
74
+ }
75
+
76
+ /**
77
+ * @member {String} name
78
+ */
79
+ exports.prototype['name'] = undefined;
80
+ /**
81
+ * @member {String} parent_folder_id
82
+ */
83
+ exports.prototype['parent_folder_id'] = undefined;
84
+
85
+
86
+
87
+ return exports;
88
+ }));
89
+
90
+
@@ -36,7 +36,7 @@
36
36
  /**
37
37
  * The CreateCombinedSubmissionResponse model module.
38
38
  * @module model/CreateCombinedSubmissionResponse
39
- * @version 1.3.0
39
+ * @version 1.4.0
40
40
  */
41
41
 
42
42
  /**
@@ -36,7 +36,7 @@
36
36
  /**
37
37
  * The CreateCustomFileData model module.
38
38
  * @module model/CreateCustomFileData
39
- * @version 1.3.0
39
+ * @version 1.4.0
40
40
  */
41
41
 
42
42
  /**
@@ -36,7 +36,7 @@
36
36
  /**
37
37
  * The CreateCustomFileResponse model module.
38
38
  * @module model/CreateCustomFileResponse
39
- * @version 1.3.0
39
+ * @version 1.4.0
40
40
  */
41
41
 
42
42
  /**