docspring 1.3.1 → 1.3.2

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 (74) hide show
  1. package/CHANGELOG.md +4 -0
  2. package/README.md +8 -2
  3. package/docs/CombinePdfsData.md +1 -0
  4. package/docs/CombinedSubmission.md +1 -0
  5. package/docs/CombinedSubmissionData.md +1 -0
  6. package/docs/ListSubmissionsResponse.md +10 -0
  7. package/docs/PDFApi.md +173 -3
  8. package/docs/SubmissionData.md +1 -0
  9. package/docs/Template1.md +59 -0
  10. package/docs/Template1Defaults.md +10 -0
  11. package/package.json +1 -1
  12. package/src/ApiClient.js +1 -1
  13. package/src/api/PDFApi.js +168 -6
  14. package/src/index.js +19 -4
  15. package/src/model/AddFieldsData.js +1 -1
  16. package/src/model/AddFieldsTemplateResponse.js +1 -1
  17. package/src/model/AuthenticationError.js +1 -1
  18. package/src/model/AuthenticationSuccessResponse.js +1 -1
  19. package/src/model/CombinePdfsData.js +9 -1
  20. package/src/model/CombinedSubmission.js +9 -1
  21. package/src/model/CombinedSubmissionAction.js +1 -1
  22. package/src/model/CombinedSubmissionData.js +9 -1
  23. package/src/model/CopyTemplateData.js +1 -1
  24. package/src/model/CreateCombinedSubmissionResponse.js +1 -1
  25. package/src/model/CreateCustomFileData.js +1 -1
  26. package/src/model/CreateCustomFileResponse.js +1 -1
  27. package/src/model/CreateFolderData.js +1 -1
  28. package/src/model/CreateHtmlTemplateData.js +1 -1
  29. package/src/model/CreateSubmissionBatchResponse.js +1 -1
  30. package/src/model/CreateSubmissionBatchSubmissionsResponse.js +1 -1
  31. package/src/model/CreateSubmissionDataRequestData.js +1 -1
  32. package/src/model/CreateSubmissionDataRequestTokenResponse.js +1 -1
  33. package/src/model/CreateSubmissionDataRequestTokenResponseToken.js +1 -1
  34. package/src/model/CreateSubmissionResponse.js +1 -1
  35. package/src/model/CreateTemplateFromUploadData.js +1 -1
  36. package/src/model/CustomFile.js +1 -1
  37. package/src/model/Error.js +1 -1
  38. package/src/model/Folder.js +1 -1
  39. package/src/model/FoldersFolder.js +1 -1
  40. package/src/model/HtmlTemplateData.js +1 -1
  41. package/src/model/InvalidRequest.js +1 -1
  42. package/src/model/ListSubmissionsResponse.js +97 -0
  43. package/src/model/MoveFolderData.js +1 -1
  44. package/src/model/MoveTemplateData.js +1 -1
  45. package/src/model/PendingTemplate.js +1 -1
  46. package/src/model/RenameFolderData.js +1 -1
  47. package/src/model/Submission.js +1 -1
  48. package/src/model/SubmissionAction.js +1 -1
  49. package/src/model/SubmissionBatch.js +1 -1
  50. package/src/model/SubmissionBatchData.js +1 -1
  51. package/src/model/SubmissionData.js +9 -1
  52. package/src/model/SubmissionDataBatchRequest.js +1 -1
  53. package/src/model/SubmissionDataRequest.js +1 -1
  54. package/src/model/Template.js +1 -1
  55. package/src/model/Template1.js +407 -0
  56. package/src/model/Template1Defaults.js +97 -0
  57. package/src/model/TemplateData.js +1 -1
  58. package/src/model/TemplatestemplateIdaddFieldsFields.js +1 -1
  59. package/src/model/UpdateDataRequestResponse.js +1 -1
  60. package/src/model/UpdateSubmissionDataRequestData.js +1 -1
  61. package/src/model/UpdateTemplateData.js +1 -1
  62. package/src/model/UpdateTemplateResponse.js +1 -1
  63. package/src/model/UploadTemplateData.js +1 -1
  64. package/src/model/UploadTemplateDataDocument.js +1 -1
  65. package/src/model/UploadTemplateDataDocumentMetadata.js +1 -1
  66. package/test/api/PDFApi.spec.js.original +30 -0
  67. package/test/model/CombinePdfsData.spec.js +6 -0
  68. package/test/model/CombinedSubmission.spec.js +6 -0
  69. package/test/model/CombinedSubmissionData.spec.js +6 -0
  70. package/test/model/ListSubmissionsResponse.spec.js +79 -0
  71. package/test/model/SubmissionData.spec.js +6 -0
  72. package/test/model/Template1.spec.js +295 -0
  73. package/test/model/Template1Defaults.spec.js +79 -0
  74. package/yarn.lock +263 -0
package/CHANGELOG.md CHANGED
@@ -1,3 +1,7 @@
1
+ ### 1.3.2 [November 28, 2021]
2
+
3
+ - Added 'password' parameter to Generate PDF and Combine PDF API endpoints. You can now encrypt each generated PDF with a unique password.
4
+
1
5
  ### 1.3.1 [November 19, 2020]
2
6
 
3
7
  - Added "sort_order" property for Submission Data Requests
package/README.md CHANGED
@@ -5,7 +5,7 @@ DocSpring is a service that helps you fill out and sign PDF templates.
5
5
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
6
6
 
7
7
  - API version: v1
8
- - Package version: 1.3.1
8
+ - Package version: 1.3.2
9
9
  - Build package: com.docspring.codegen.DocSpringJavascriptClientCodegen
10
10
 
11
11
  ## Installation
@@ -141,12 +141,15 @@ Class | Method | HTTP request | Description
141
141
  *DocSpring.PDFApi* | [**generatePDF**](docs/PDFApi.md#generatePDF) | **POST** /templates/{template_id}/submissions | Generates a new PDF
142
142
  *DocSpring.PDFApi* | [**getCombinedSubmission**](docs/PDFApi.md#getCombinedSubmission) | **GET** /combined_submissions/{combined_submission_id} | Check the status of a combined submission (merged PDFs)
143
143
  *DocSpring.PDFApi* | [**getDataRequest**](docs/PDFApi.md#getDataRequest) | **GET** /data_requests/{data_request_id} | Look up a submission data request
144
+ *DocSpring.PDFApi* | [**getFullTemplate**](docs/PDFApi.md#getFullTemplate) | **GET** /templates/{template_id}?full=true | Fetch the full template attributes
144
145
  *DocSpring.PDFApi* | [**getPresignUrl**](docs/PDFApi.md#getPresignUrl) | **GET** /uploads/presign | Get a presigned URL so that you can upload a file to our AWS S3 bucket
145
146
  *DocSpring.PDFApi* | [**getSubmission**](docs/PDFApi.md#getSubmission) | **GET** /submissions/{submission_id} | Check the status of a PDF
146
147
  *DocSpring.PDFApi* | [**getSubmissionBatch**](docs/PDFApi.md#getSubmissionBatch) | **GET** /submissions/batches/{submission_batch_id} | Check the status of a submission batch job
147
- *DocSpring.PDFApi* | [**getTemplate**](docs/PDFApi.md#getTemplate) | **GET** /templates/{template_id} | Get a single template
148
+ *DocSpring.PDFApi* | [**getTemplate**](docs/PDFApi.md#getTemplate) | **GET** /templates/{template_id} | Check the status of an uploaded template
148
149
  *DocSpring.PDFApi* | [**getTemplateSchema**](docs/PDFApi.md#getTemplateSchema) | **GET** /templates/{template_id}/schema | Fetch the JSON schema for a template
149
150
  *DocSpring.PDFApi* | [**listFolders**](docs/PDFApi.md#listFolders) | **GET** /folders/ | Get a list of all folders
151
+ *DocSpring.PDFApi* | [**listSubmissions**](docs/PDFApi.md#listSubmissions) | **GET** /submissions | List all submissions
152
+ *DocSpring.PDFApi* | [**listSubmissions_0**](docs/PDFApi.md#listSubmissions_0) | **GET** /templates/{template_id}/submissions | List all submissions for a given template
150
153
  *DocSpring.PDFApi* | [**listTemplates**](docs/PDFApi.md#listTemplates) | **GET** /templates | Get a list of all templates
151
154
  *DocSpring.PDFApi* | [**moveFolderToFolder**](docs/PDFApi.md#moveFolderToFolder) | **POST** /folders/{folder_id}/move | Move a folder
152
155
  *DocSpring.PDFApi* | [**moveTemplateToFolder**](docs/PDFApi.md#moveTemplateToFolder) | **POST** /templates/{template_id}/move | Move Template to folder
@@ -185,6 +188,7 @@ Class | Method | HTTP request | Description
185
188
  - [DocSpring.FoldersFolder](docs/FoldersFolder.md)
186
189
  - [DocSpring.HtmlTemplateData](docs/HtmlTemplateData.md)
187
190
  - [DocSpring.InvalidRequest](docs/InvalidRequest.md)
191
+ - [DocSpring.ListSubmissionsResponse](docs/ListSubmissionsResponse.md)
188
192
  - [DocSpring.MoveFolderData](docs/MoveFolderData.md)
189
193
  - [DocSpring.MoveTemplateData](docs/MoveTemplateData.md)
190
194
  - [DocSpring.PendingTemplate](docs/PendingTemplate.md)
@@ -197,6 +201,8 @@ Class | Method | HTTP request | Description
197
201
  - [DocSpring.SubmissionDataBatchRequest](docs/SubmissionDataBatchRequest.md)
198
202
  - [DocSpring.SubmissionDataRequest](docs/SubmissionDataRequest.md)
199
203
  - [DocSpring.Template](docs/Template.md)
204
+ - [DocSpring.Template1](docs/Template1.md)
205
+ - [DocSpring.Template1Defaults](docs/Template1Defaults.md)
200
206
  - [DocSpring.TemplateData](docs/TemplateData.md)
201
207
  - [DocSpring.TemplatestemplateIdaddFieldsFields](docs/TemplatestemplateIdaddFieldsFields.md)
202
208
  - [DocSpring.UpdateDataRequestResponse](docs/UpdateDataRequestResponse.md)
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
6
6
  **deleteCustomFiles** | **Boolean** | | [optional]
7
7
  **expiresIn** | **Number** | | [optional]
8
8
  **metadata** | **Object** | | [optional]
9
+ **password** | **String** | | [optional]
9
10
  **sourcePdfs** | **[Object]** | |
10
11
  **test** | **Boolean** | | [optional]
11
12
 
@@ -4,6 +4,7 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **metadata** | **Object** | | [optional]
7
+ **password** | **String** | | [optional]
7
8
  **expired** | **Boolean** | | [optional]
8
9
  **expiresAt** | **String** | | [optional]
9
10
  **sourcePdfs** | **[Object]** | | [optional]
@@ -5,6 +5,7 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **expiresIn** | **Number** | | [optional]
7
7
  **metadata** | **Object** | | [optional]
8
+ **password** | **String** | | [optional]
8
9
  **submissionIds** | **[String]** | |
9
10
  **test** | **Boolean** | | [optional]
10
11
 
@@ -0,0 +1,10 @@
1
+ # DocSpring.ListSubmissionsResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **nextCursor** | **String** | | [optional]
7
+ **submissions** | [**[Submission]**](Submission.md) | | [optional]
8
+ **limit** | **Number** | | [optional]
9
+
10
+
package/docs/PDFApi.md CHANGED
@@ -22,12 +22,15 @@ Method | HTTP request | Description
22
22
  [**generatePDF**](PDFApi.md#generatePDF) | **POST** /templates/{template_id}/submissions | Generates a new PDF
23
23
  [**getCombinedSubmission**](PDFApi.md#getCombinedSubmission) | **GET** /combined_submissions/{combined_submission_id} | Check the status of a combined submission (merged PDFs)
24
24
  [**getDataRequest**](PDFApi.md#getDataRequest) | **GET** /data_requests/{data_request_id} | Look up a submission data request
25
+ [**getFullTemplate**](PDFApi.md#getFullTemplate) | **GET** /templates/{template_id}?full=true | Fetch the full template attributes
25
26
  [**getPresignUrl**](PDFApi.md#getPresignUrl) | **GET** /uploads/presign | Get a presigned URL so that you can upload a file to our AWS S3 bucket
26
27
  [**getSubmission**](PDFApi.md#getSubmission) | **GET** /submissions/{submission_id} | Check the status of a PDF
27
28
  [**getSubmissionBatch**](PDFApi.md#getSubmissionBatch) | **GET** /submissions/batches/{submission_batch_id} | Check the status of a submission batch job
28
- [**getTemplate**](PDFApi.md#getTemplate) | **GET** /templates/{template_id} | Get a single template
29
+ [**getTemplate**](PDFApi.md#getTemplate) | **GET** /templates/{template_id} | Check the status of an uploaded template
29
30
  [**getTemplateSchema**](PDFApi.md#getTemplateSchema) | **GET** /templates/{template_id}/schema | Fetch the JSON schema for a template
30
31
  [**listFolders**](PDFApi.md#listFolders) | **GET** /folders/ | Get a list of all folders
32
+ [**listSubmissions**](PDFApi.md#listSubmissions) | **GET** /submissions | List all submissions
33
+ [**listSubmissions_0**](PDFApi.md#listSubmissions_0) | **GET** /templates/{template_id}/submissions | List all submissions for a given template
31
34
  [**listTemplates**](PDFApi.md#listTemplates) | **GET** /templates | Get a list of all templates
32
35
  [**moveFolderToFolder**](PDFApi.md#moveFolderToFolder) | **POST** /folders/{folder_id}/move | Move a folder
33
36
  [**moveTemplateToFolder**](PDFApi.md#moveTemplateToFolder) | **POST** /templates/{template_id}/move | Move Template to folder
@@ -892,6 +895,53 @@ Name | Type | Description | Notes
892
895
 
893
896
  [api_token_basic](../README.md#api_token_basic)
894
897
 
898
+ ### HTTP request headers
899
+
900
+ - **Content-Type**: Not defined
901
+ - **Accept**: application/json
902
+
903
+ <a name="getFullTemplate"></a>
904
+ # **getFullTemplate**
905
+ > Template1 getFullTemplate(templateId)
906
+
907
+ Fetch the full template attributes
908
+
909
+ ### Example
910
+ ```javascript
911
+ var DocSpring = require('docspring');
912
+ var defaultClient = DocSpring.ApiClient.instance;
913
+
914
+ // Configure HTTP basic authorization: api_token_basic
915
+ var api_token_basic = defaultClient.authentications['api_token_basic'];
916
+ api_token_basic.username = 'YOUR USERNAME';
917
+ api_token_basic.password = 'YOUR PASSWORD';
918
+
919
+ var apiInstance = new DocSpring.PDFApi();
920
+ var templateId = tpl_000000000000000001; // String |
921
+ var callback = function(error, data, response) {
922
+ if (error) {
923
+ console.error(error);
924
+ } else {
925
+ console.log('API called successfully. Returned data: ' + data);
926
+ }
927
+ };
928
+ apiInstance.getFullTemplate(templateId, callback);
929
+ ```
930
+
931
+ ### Parameters
932
+
933
+ Name | Type | Description | Notes
934
+ ------------- | ------------- | ------------- | -------------
935
+ **templateId** | **String**| |
936
+
937
+ ### Return type
938
+
939
+ [**Template1**](Template1.md)
940
+
941
+ ### Authorization
942
+
943
+ [api_token_basic](../README.md#api_token_basic)
944
+
895
945
  ### HTTP request headers
896
946
 
897
947
  - **Content-Type**: Not defined
@@ -1046,7 +1096,7 @@ Name | Type | Description | Notes
1046
1096
  # **getTemplate**
1047
1097
  > Template getTemplate(templateId)
1048
1098
 
1049
- Get a single template
1099
+ Check the status of an uploaded template
1050
1100
 
1051
1101
  ### Example
1052
1102
  ```javascript
@@ -1059,7 +1109,7 @@ api_token_basic.username = 'YOUR USERNAME';
1059
1109
  api_token_basic.password = 'YOUR PASSWORD';
1060
1110
 
1061
1111
  var apiInstance = new DocSpring.PDFApi();
1062
- var templateId = tpl_000000000000000011; // String |
1112
+ var templateId = tpl_000000000000000001; // String |
1063
1113
  var callback = function(error, data, response) {
1064
1114
  if (error) {
1065
1115
  console.error(error);
@@ -1180,6 +1230,126 @@ Name | Type | Description | Notes
1180
1230
 
1181
1231
  [api_token_basic](../README.md#api_token_basic)
1182
1232
 
1233
+ ### HTTP request headers
1234
+
1235
+ - **Content-Type**: Not defined
1236
+ - **Accept**: application/json
1237
+
1238
+ <a name="listSubmissions"></a>
1239
+ # **listSubmissions**
1240
+ > ListSubmissionsResponse listSubmissions(opts)
1241
+
1242
+ List all submissions
1243
+
1244
+ ### Example
1245
+ ```javascript
1246
+ var DocSpring = require('docspring');
1247
+ var defaultClient = DocSpring.ApiClient.instance;
1248
+
1249
+ // Configure HTTP basic authorization: api_token_basic
1250
+ var api_token_basic = defaultClient.authentications['api_token_basic'];
1251
+ api_token_basic.username = 'YOUR USERNAME';
1252
+ api_token_basic.password = 'YOUR PASSWORD';
1253
+
1254
+ var apiInstance = new DocSpring.PDFApi();
1255
+ var opts = {
1256
+ 'cursor': sub_list_000012, // String |
1257
+ 'limit': 3, // Number |
1258
+ 'createdAfter': 2019-01-01T09:00:00-05:00, // String |
1259
+ 'createdBefore': 2020-01-01T09:00:00-05:00, // String |
1260
+ 'type': test, // String |
1261
+ 'includeData': true // Boolean |
1262
+ };
1263
+ var callback = function(error, data, response) {
1264
+ if (error) {
1265
+ console.error(error);
1266
+ } else {
1267
+ console.log('API called successfully. Returned data: ' + data);
1268
+ }
1269
+ };
1270
+ apiInstance.listSubmissions(opts, callback);
1271
+ ```
1272
+
1273
+ ### Parameters
1274
+
1275
+ Name | Type | Description | Notes
1276
+ ------------- | ------------- | ------------- | -------------
1277
+ **cursor** | **String**| | [optional]
1278
+ **limit** | **Number**| | [optional]
1279
+ **createdAfter** | **String**| | [optional]
1280
+ **createdBefore** | **String**| | [optional]
1281
+ **type** | **String**| | [optional]
1282
+ **includeData** | **Boolean**| | [optional]
1283
+
1284
+ ### Return type
1285
+
1286
+ [**ListSubmissionsResponse**](ListSubmissionsResponse.md)
1287
+
1288
+ ### Authorization
1289
+
1290
+ [api_token_basic](../README.md#api_token_basic)
1291
+
1292
+ ### HTTP request headers
1293
+
1294
+ - **Content-Type**: Not defined
1295
+ - **Accept**: application/json
1296
+
1297
+ <a name="listSubmissions_0"></a>
1298
+ # **listSubmissions_0**
1299
+ > ListSubmissionsResponse listSubmissions_0(templateId, opts)
1300
+
1301
+ List all submissions for a given template
1302
+
1303
+ ### Example
1304
+ ```javascript
1305
+ var DocSpring = require('docspring');
1306
+ var defaultClient = DocSpring.ApiClient.instance;
1307
+
1308
+ // Configure HTTP basic authorization: api_token_basic
1309
+ var api_token_basic = defaultClient.authentications['api_token_basic'];
1310
+ api_token_basic.username = 'YOUR USERNAME';
1311
+ api_token_basic.password = 'YOUR PASSWORD';
1312
+
1313
+ var apiInstance = new DocSpring.PDFApi();
1314
+ var templateId = tpl_000000000000000002; // String |
1315
+ var opts = {
1316
+ 'cursor': "cursor_example", // String |
1317
+ 'limit': 3.4, // Number |
1318
+ 'createdAfter': "createdAfter_example", // String |
1319
+ 'createdBefore': "createdBefore_example", // String |
1320
+ 'type': "type_example", // String |
1321
+ 'includeData': true // Boolean |
1322
+ };
1323
+ var callback = function(error, data, response) {
1324
+ if (error) {
1325
+ console.error(error);
1326
+ } else {
1327
+ console.log('API called successfully. Returned data: ' + data);
1328
+ }
1329
+ };
1330
+ apiInstance.listSubmissions_0(templateId, opts, callback);
1331
+ ```
1332
+
1333
+ ### Parameters
1334
+
1335
+ Name | Type | Description | Notes
1336
+ ------------- | ------------- | ------------- | -------------
1337
+ **templateId** | **String**| |
1338
+ **cursor** | **String**| | [optional]
1339
+ **limit** | **Number**| | [optional]
1340
+ **createdAfter** | **String**| | [optional]
1341
+ **createdBefore** | **String**| | [optional]
1342
+ **type** | **String**| | [optional]
1343
+ **includeData** | **Boolean**| | [optional]
1344
+
1345
+ ### Return type
1346
+
1347
+ [**ListSubmissionsResponse**](ListSubmissionsResponse.md)
1348
+
1349
+ ### Authorization
1350
+
1351
+ [api_token_basic](../README.md#api_token_basic)
1352
+
1183
1353
  ### HTTP request headers
1184
1354
 
1185
1355
  - **Content-Type**: Not defined
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
9
9
  **fieldOverrides** | **Object** | | [optional]
10
10
  **html** | **String** | | [optional]
11
11
  **metadata** | **Object** | | [optional]
12
+ **password** | **String** | | [optional]
12
13
  **test** | **Boolean** | | [optional]
13
14
 
14
15
 
@@ -0,0 +1,59 @@
1
+ # DocSpring.Template1
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **documentProcessed** | **Boolean** | | [optional]
7
+ **expirationInterval** | **String** | | [optional]
8
+ **scss** | **String** | | [optional]
9
+ **documentState** | **String** | | [optional]
10
+ **expireAfter** | **Number** | | [optional]
11
+ **description** | **String** | | [optional]
12
+ **slackWebhookUrl** | **String** | | [optional]
13
+ **demo** | **Boolean** | | [optional]
14
+ **path** | **String** | | [optional]
15
+ **headerHtml** | **String** | | [optional]
16
+ **publicWebForm** | **Boolean** | | [optional]
17
+ **fieldOrder** | **[[Number]]** | | [optional]
18
+ **permanentDocumentUrl** | **String** | | [optional]
19
+ **html** | **String** | | [optional]
20
+ **templateType** | **String** | | [optional]
21
+ **id** | **String** | | [optional]
22
+ **pageDimensions** | **[[Number]]** | | [optional]
23
+ **locked** | **Boolean** | | [optional]
24
+ **pageCount** | **Number** | | [optional]
25
+ **encryptPdfs** | **Boolean** | | [optional]
26
+ **webhookUrl** | **String** | | [optional]
27
+ **embedDomains** | **[String]** | | [optional]
28
+ **parentFolderId** | **String** | | [optional]
29
+ **allowAdditionalProperties** | **Boolean** | | [optional]
30
+ **encryptPdfsPassword** | **String** | | [optional]
31
+ **publicSubmissions** | **Boolean** | | [optional]
32
+ **sharedFieldData** | **Object** | | [optional]
33
+ **documentMd5** | **String** | | [optional]
34
+ **firstTemplate** | **Boolean** | | [optional]
35
+ **defaults** | [**Template1Defaults**](Template1Defaults.md) | | [optional]
36
+ **editableSubmissions** | **Boolean** | | [optional]
37
+ **expireSubmissions** | **Boolean** | | [optional]
38
+ **name** | **String** | | [optional]
39
+ **footerHtml** | **String** | | [optional]
40
+ **documentParseError** | **Boolean** | | [optional]
41
+ **fields** | **Object** | | [optional]
42
+ **documentFilename** | **String** | | [optional]
43
+ **redirectUrl** | **String** | | [optional]
44
+ **documentUrl** | **String** | | [optional]
45
+
46
+
47
+ <a name="ExpirationIntervalEnum"></a>
48
+ ## Enum: ExpirationIntervalEnum
49
+
50
+
51
+ * `minutes` (value: `"minutes"`)
52
+
53
+ * `hours` (value: `"hours"`)
54
+
55
+ * `days` (value: `"days"`)
56
+
57
+
58
+
59
+
@@ -0,0 +1,10 @@
1
+ # DocSpring.Template1Defaults
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **color** | **String** | | [optional]
7
+ **fontSize** | **Number** | | [optional]
8
+ **typeface** | **String** | | [optional]
9
+
10
+
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "docspring",
3
- "version": "1.3.1",
3
+ "version": "1.3.2",
4
4
  "description": "An API client for the DocSpring PDF generation service",
5
5
  "license": "Unlicense",
6
6
  "main": "src/index.js",
package/src/ApiClient.js CHANGED
@@ -32,7 +32,7 @@
32
32
 
33
33
  /**
34
34
  * @module ApiClient
35
- * @version 1.3.1
35
+ * @version 1.3.2
36
36
  */
37
37
 
38
38
  /**
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/CopyTemplateData', '../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/InvalidRequest', '../model/ListSubmissionsResponse', '../model/MoveFolderData', '../model/MoveTemplateData', '../model/PendingTemplate', '../model/RenameFolderData', '../model/Submission', '../model/SubmissionBatch', '../model/SubmissionBatchData', '../model/SubmissionData', '../model/SubmissionDataRequest', '../model/Template', '../model/Template1', '../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/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/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/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/Template1'), 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.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.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.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.Template1, 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, CopyTemplateData, 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, InvalidRequest, ListSubmissionsResponse, MoveFolderData, MoveTemplateData, PendingTemplate, RenameFolderData, Submission, SubmissionBatch, SubmissionBatchData, SubmissionData, SubmissionDataRequest, Template, Template1, 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.1
36
+ * @version 1.3.2
37
37
  */
38
38
 
39
39
  /**
@@ -921,6 +921,53 @@
921
921
  );
922
922
  }
923
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/Template1} 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/Template1}
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 = Template1;
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
+
924
971
  /**
925
972
  * Callback function to receive the result of the getPresignUrl operation.
926
973
  * @callback module:api/PDFApi~getPresignUrlCallback
@@ -1072,7 +1119,7 @@
1072
1119
  */
1073
1120
 
1074
1121
  /**
1075
- * Get a single template
1122
+ * Check the status of an uploaded template
1076
1123
  * @param {String} templateId
1077
1124
  * @param {module:api/PDFApi~getTemplateCallback} callback The callback function, accepting three arguments: error, data, response
1078
1125
  * data is of type: {@link module:model/Template}
@@ -1201,6 +1248,121 @@
1201
1248
  );
1202
1249
  }
1203
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
+
1204
1366
  /**
1205
1367
  * Callback function to receive the result of the listTemplates operation.
1206
1368
  * @callback module:api/PDFApi~listTemplatesCallback