docspring 1.4.0 → 1.5.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 (69) hide show
  1. package/CHANGELOG.md +4 -0
  2. package/README.md +3 -1
  3. package/docs/CombinedSubmission.md +2 -0
  4. package/docs/PDFApi.md +101 -1
  5. package/docs/SubmissionData.md +1 -0
  6. package/docs/SubmissionDataRequest.md +1 -0
  7. package/package.json +1 -1
  8. package/src/ApiClient.js +1 -1
  9. package/src/api/Client.js +263 -250
  10. package/src/api/PDFApi.js +94 -1
  11. package/src/index.js +1 -1
  12. package/src/model/AddFieldsData.js +1 -1
  13. package/src/model/AddFieldsTemplateResponse.js +1 -1
  14. package/src/model/AuthenticationError.js +1 -1
  15. package/src/model/AuthenticationSuccessResponse.js +1 -1
  16. package/src/model/CombinePdfsData.js +1 -1
  17. package/src/model/CombinedSubmission.js +17 -1
  18. package/src/model/CombinedSubmissionAction.js +1 -1
  19. package/src/model/CombinedSubmissionData.js +1 -1
  20. package/src/model/CopyTemplateData.js +1 -1
  21. package/src/model/CreateCombinedSubmissionResponse.js +1 -1
  22. package/src/model/CreateCustomFileData.js +1 -1
  23. package/src/model/CreateCustomFileResponse.js +1 -1
  24. package/src/model/CreateFolderData.js +1 -1
  25. package/src/model/CreateHtmlTemplateData.js +1 -1
  26. package/src/model/CreateSubmissionBatchResponse.js +1 -1
  27. package/src/model/CreateSubmissionBatchSubmissionsResponse.js +1 -1
  28. package/src/model/CreateSubmissionDataRequestData.js +1 -1
  29. package/src/model/CreateSubmissionDataRequestTokenResponse.js +1 -1
  30. package/src/model/CreateSubmissionDataRequestTokenResponseToken.js +1 -1
  31. package/src/model/CreateSubmissionResponse.js +1 -1
  32. package/src/model/CreateTemplateFromUploadData.js +1 -1
  33. package/src/model/CustomFile.js +1 -1
  34. package/src/model/Error.js +1 -1
  35. package/src/model/Folder.js +1 -1
  36. package/src/model/FoldersFolder.js +1 -1
  37. package/src/model/FullTemplate.js +1 -1
  38. package/src/model/FullTemplateDefaults.js +1 -1
  39. package/src/model/HtmlTemplateData.js +1 -1
  40. package/src/model/InvalidRequest.js +1 -1
  41. package/src/model/ListSubmissionsResponse.js +1 -1
  42. package/src/model/MoveFolderData.js +1 -1
  43. package/src/model/MoveTemplateData.js +1 -1
  44. package/src/model/PendingTemplate.js +1 -1
  45. package/src/model/RenameFolderData.js +1 -1
  46. package/src/model/Submission.js +1 -1
  47. package/src/model/SubmissionAction.js +1 -1
  48. package/src/model/SubmissionBatch.js +1 -1
  49. package/src/model/SubmissionBatchData.js +1 -1
  50. package/src/model/SubmissionData.js +9 -1
  51. package/src/model/SubmissionDataBatchRequest.js +1 -1
  52. package/src/model/SubmissionDataRequest.js +9 -1
  53. package/src/model/Template.js +1 -1
  54. package/src/model/TemplateData.js +1 -1
  55. package/src/model/TemplatestemplateIdaddFieldsFields.js +1 -1
  56. package/src/model/UpdateDataRequestResponse.js +1 -1
  57. package/src/model/UpdateSubmissionDataRequestData.js +1 -1
  58. package/src/model/UpdateTemplateData.js +1 -1
  59. package/src/model/UpdateTemplateResponse.js +1 -1
  60. package/src/model/UploadTemplateData.js +1 -1
  61. package/src/model/UploadTemplateDataDocument.js +1 -1
  62. package/src/model/UploadTemplateDataDocumentMetadata.js +1 -1
  63. package/test/api/ClientIntegration.spec.js +64 -58
  64. package/test/api/PDFApi.spec.js.original +20 -0
  65. package/test/api/PDFApiIntegration.spec.js +99 -95
  66. package/test/model/CombinedSubmission.spec.js +12 -0
  67. package/test/model/SubmissionData.spec.js +6 -0
  68. package/test/model/SubmissionDataRequest.spec.js +6 -0
  69. package/yarn.lock +0 -263
package/CHANGELOG.md CHANGED
@@ -1,3 +1,7 @@
1
+ ### 1.5.0 [August 30, 2023]
2
+
3
+ - Added Delete Template API endpoint
4
+
1
5
  ### 1.4.0 [March 22, 2022]
2
6
 
3
7
  - Renamed "Template1" model to "FullTemplate" since it includes all properties
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.4.0
8
+ - Package version: 1.5.0
9
9
  - Build package: com.docspring.codegen.DocSpringJavascriptClientCodegen
10
10
 
11
11
  ## Installation
@@ -136,6 +136,7 @@ Class | Method | HTTP request | Description
136
136
  *DocSpring.PDFApi* | [**createPDFTemplate**](docs/PDFApi.md#createPDFTemplate) | **POST** /templates | Create a new PDF template with a form POST file upload
137
137
  *DocSpring.PDFApi* | [**createPDFTemplateFromUpload**](docs/PDFApi.md#createPDFTemplateFromUpload) | **POST** /templates?desc=cached_upload | Create a new PDF template from a cached presign upload
138
138
  *DocSpring.PDFApi* | [**deleteFolder**](docs/PDFApi.md#deleteFolder) | **DELETE** /folders/{folder_id} | Delete a folder
139
+ *DocSpring.PDFApi* | [**deleteTemplate**](docs/PDFApi.md#deleteTemplate) | **DELETE** /templates/{template_id} | Delete a template
139
140
  *DocSpring.PDFApi* | [**expireCombinedSubmission**](docs/PDFApi.md#expireCombinedSubmission) | **DELETE** /combined_submissions/{combined_submission_id} | Expire a combined submission
140
141
  *DocSpring.PDFApi* | [**expireSubmission**](docs/PDFApi.md#expireSubmission) | **DELETE** /submissions/{submission_id} | Expire a PDF submission
141
142
  *DocSpring.PDFApi* | [**generatePDF**](docs/PDFApi.md#generatePDF) | **POST** /templates/{template_id}/submissions | Generates a new PDF
@@ -147,6 +148,7 @@ Class | Method | HTTP request | Description
147
148
  *DocSpring.PDFApi* | [**getSubmissionBatch**](docs/PDFApi.md#getSubmissionBatch) | **GET** /submissions/batches/{submission_batch_id} | Check the status of a submission batch job
148
149
  *DocSpring.PDFApi* | [**getTemplate**](docs/PDFApi.md#getTemplate) | **GET** /templates/{template_id} | Check the status of an uploaded template
149
150
  *DocSpring.PDFApi* | [**getTemplateSchema**](docs/PDFApi.md#getTemplateSchema) | **GET** /templates/{template_id}/schema | Fetch the JSON schema for a template
151
+ *DocSpring.PDFApi* | [**listCombinedSubmissions**](docs/PDFApi.md#listCombinedSubmissions) | **GET** /combined_submissions | Get a list of all combined submissions
150
152
  *DocSpring.PDFApi* | [**listFolders**](docs/PDFApi.md#listFolders) | **GET** /folders/ | Get a list of all folders
151
153
  *DocSpring.PDFApi* | [**listSubmissions**](docs/PDFApi.md#listSubmissions) | **GET** /submissions | List all submissions
152
154
  *DocSpring.PDFApi* | [**listSubmissions_0**](docs/PDFApi.md#listSubmissions_0) | **GET** /templates/{template_id}/submissions | List all submissions for a given template
@@ -3,6 +3,7 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
+ **errorMessage** | **String** | | [optional]
6
7
  **metadata** | **Object** | | [optional]
7
8
  **password** | **String** | | [optional]
8
9
  **expired** | **Boolean** | | [optional]
@@ -13,6 +14,7 @@ Name | Type | Description | Notes
13
14
  **submissionIds** | **[String]** | | [optional]
14
15
  **id** | **String** | | [optional]
15
16
  **state** | **String** | | [optional]
17
+ **expiresIn** | **Number** | | [optional]
16
18
  **actions** | [**[CombinedSubmissionAction]**](CombinedSubmissionAction.md) | | [optional]
17
19
 
18
20
 
package/docs/PDFApi.md CHANGED
@@ -17,6 +17,7 @@ Method | HTTP request | Description
17
17
  [**createPDFTemplate**](PDFApi.md#createPDFTemplate) | **POST** /templates | Create a new PDF template with a form POST file upload
18
18
  [**createPDFTemplateFromUpload**](PDFApi.md#createPDFTemplateFromUpload) | **POST** /templates?desc=cached_upload | Create a new PDF template from a cached presign upload
19
19
  [**deleteFolder**](PDFApi.md#deleteFolder) | **DELETE** /folders/{folder_id} | Delete a folder
20
+ [**deleteTemplate**](PDFApi.md#deleteTemplate) | **DELETE** /templates/{template_id} | Delete a template
20
21
  [**expireCombinedSubmission**](PDFApi.md#expireCombinedSubmission) | **DELETE** /combined_submissions/{combined_submission_id} | Expire a combined submission
21
22
  [**expireSubmission**](PDFApi.md#expireSubmission) | **DELETE** /submissions/{submission_id} | Expire a PDF submission
22
23
  [**generatePDF**](PDFApi.md#generatePDF) | **POST** /templates/{template_id}/submissions | Generates a new PDF
@@ -28,6 +29,7 @@ Method | HTTP request | Description
28
29
  [**getSubmissionBatch**](PDFApi.md#getSubmissionBatch) | **GET** /submissions/batches/{submission_batch_id} | Check the status of a submission batch job
29
30
  [**getTemplate**](PDFApi.md#getTemplate) | **GET** /templates/{template_id} | Check the status of an uploaded template
30
31
  [**getTemplateSchema**](PDFApi.md#getTemplateSchema) | **GET** /templates/{template_id}/schema | Fetch the JSON schema for a template
32
+ [**listCombinedSubmissions**](PDFApi.md#listCombinedSubmissions) | **GET** /combined_submissions | Get a list of all combined submissions
31
33
  [**listFolders**](PDFApi.md#listFolders) | **GET** /folders/ | Get a list of all folders
32
34
  [**listSubmissions**](PDFApi.md#listSubmissions) | **GET** /submissions | List all submissions
33
35
  [**listSubmissions_0**](PDFApi.md#listSubmissions_0) | **GET** /templates/{template_id}/submissions | List all submissions for a given template
@@ -658,6 +660,53 @@ Name | Type | Description | Notes
658
660
 
659
661
  [api_token_basic](../README.md#api_token_basic)
660
662
 
663
+ ### HTTP request headers
664
+
665
+ - **Content-Type**: Not defined
666
+ - **Accept**: application/json
667
+
668
+ <a name="deleteTemplate"></a>
669
+ # **deleteTemplate**
670
+ > UpdateTemplateResponse deleteTemplate(templateId)
671
+
672
+ Delete a template
673
+
674
+ ### Example
675
+ ```javascript
676
+ var DocSpring = require('docspring');
677
+ var defaultClient = DocSpring.ApiClient.instance;
678
+
679
+ // Configure HTTP basic authorization: api_token_basic
680
+ var api_token_basic = defaultClient.authentications['api_token_basic'];
681
+ api_token_basic.username = 'YOUR USERNAME';
682
+ api_token_basic.password = 'YOUR PASSWORD';
683
+
684
+ var apiInstance = new DocSpring.PDFApi();
685
+ var templateId = tpl_000000000000000001; // String |
686
+ var callback = function(error, data, response) {
687
+ if (error) {
688
+ console.error(error);
689
+ } else {
690
+ console.log('API called successfully. Returned data: ' + data);
691
+ }
692
+ };
693
+ apiInstance.deleteTemplate(templateId, callback);
694
+ ```
695
+
696
+ ### Parameters
697
+
698
+ Name | Type | Description | Notes
699
+ ------------- | ------------- | ------------- | -------------
700
+ **templateId** | **String**| |
701
+
702
+ ### Return type
703
+
704
+ [**UpdateTemplateResponse**](UpdateTemplateResponse.md)
705
+
706
+ ### Authorization
707
+
708
+ [api_token_basic](../README.md#api_token_basic)
709
+
661
710
  ### HTTP request headers
662
711
 
663
712
  - **Content-Type**: Not defined
@@ -1181,6 +1230,57 @@ Name | Type | Description | Notes
1181
1230
 
1182
1231
  [api_token_basic](../README.md#api_token_basic)
1183
1232
 
1233
+ ### HTTP request headers
1234
+
1235
+ - **Content-Type**: Not defined
1236
+ - **Accept**: application/json
1237
+
1238
+ <a name="listCombinedSubmissions"></a>
1239
+ # **listCombinedSubmissions**
1240
+ > [CombinedSubmission] listCombinedSubmissions(opts)
1241
+
1242
+ Get a list of all combined 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
+ 'page': 2, // Number | Default: 1
1257
+ 'perPage': 1 // Number | Default: 50
1258
+ };
1259
+ var callback = function(error, data, response) {
1260
+ if (error) {
1261
+ console.error(error);
1262
+ } else {
1263
+ console.log('API called successfully. Returned data: ' + data);
1264
+ }
1265
+ };
1266
+ apiInstance.listCombinedSubmissions(opts, callback);
1267
+ ```
1268
+
1269
+ ### Parameters
1270
+
1271
+ Name | Type | Description | Notes
1272
+ ------------- | ------------- | ------------- | -------------
1273
+ **page** | **Number**| Default: 1 | [optional]
1274
+ **perPage** | **Number**| Default: 50 | [optional]
1275
+
1276
+ ### Return type
1277
+
1278
+ [**[CombinedSubmission]**](CombinedSubmission.md)
1279
+
1280
+ ### Authorization
1281
+
1282
+ [api_token_basic](../README.md#api_token_basic)
1283
+
1184
1284
  ### HTTP request headers
1185
1285
 
1186
1286
  - **Content-Type**: Not defined
@@ -1256,7 +1356,7 @@ var opts = {
1256
1356
  'cursor': sub_list_000012, // String |
1257
1357
  'limit': 3, // Number |
1258
1358
  'createdAfter': 2019-01-01T09:00:00-05:00, // String |
1259
- 'createdBefore': 2020-01-01T09:00:00-05:00, // String |
1359
+ 'createdBefore': 2020-01-01T09:00:00.000+0200, // String |
1260
1360
  'type': test, // String |
1261
1361
  'includeData': true // Boolean |
1262
1362
  };
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
6
6
  **css** | **String** | | [optional]
7
7
  **data** | **Object** | |
8
8
  **dataRequests** | [**[CreateSubmissionDataRequestData]**](CreateSubmissionDataRequestData.md) | | [optional]
9
+ **expiresIn** | **Number** | | [optional]
9
10
  **fieldOverrides** | **Object** | | [optional]
10
11
  **html** | **String** | | [optional]
11
12
  **metadata** | **Object** | | [optional]
@@ -4,6 +4,7 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **id** | **String** | |
7
+ **submissionId** | **String** | | [optional]
7
8
  **name** | **String** | |
8
9
  **email** | **String** | |
9
10
  **order** | **Number** | |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "docspring",
3
- "version": "1.4.0",
3
+ "version": "1.5.0",
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.4.0
35
+ * @version 1.5.0
36
36
  */
37
37
 
38
38
  /**