docspring 1.3.2 → 1.5.0

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+### 1.5.0 [August 30, 2023]
+
+- Added Delete Template API endpoint
+
+### 1.4.0 [March 22, 2022]
+
+- Renamed "Template1" model to "FullTemplate" since it includes all properties
+
 ### 1.3.2 [November 28, 2021]
 
 - Added 'password' parameter to Generate PDF and Combine PDF API endpoints. You can now encrypt each generated PDF with a unique password.

package/README.md

@@ -5,7 +5,7 @@ DocSpring is a service that helps you fill out and sign PDF templates.
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: v1
-- Package version: 1.3.2
+- Package version: 1.5.0
 - Build package: com.docspring.codegen.DocSpringJavascriptClientCodegen
 
 ## Installation
@@ -136,6 +136,7 @@ Class | Method | HTTP request | Description
 *DocSpring.PDFApi* | [**createPDFTemplate**](docs/PDFApi.md#createPDFTemplate) | **POST** /templates | Create a new PDF template with a form POST file upload
 *DocSpring.PDFApi* | [**createPDFTemplateFromUpload**](docs/PDFApi.md#createPDFTemplateFromUpload) | **POST** /templates?desc=cached_upload | Create a new PDF template from a cached presign upload
 *DocSpring.PDFApi* | [**deleteFolder**](docs/PDFApi.md#deleteFolder) | **DELETE** /folders/{folder_id} | Delete a folder
+*DocSpring.PDFApi* | [**deleteTemplate**](docs/PDFApi.md#deleteTemplate) | **DELETE** /templates/{template_id} | Delete a template
 *DocSpring.PDFApi* | [**expireCombinedSubmission**](docs/PDFApi.md#expireCombinedSubmission) | **DELETE** /combined_submissions/{combined_submission_id} | Expire a combined submission
 *DocSpring.PDFApi* | [**expireSubmission**](docs/PDFApi.md#expireSubmission) | **DELETE** /submissions/{submission_id} | Expire a PDF submission
 *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
 *DocSpring.PDFApi* | [**getSubmissionBatch**](docs/PDFApi.md#getSubmissionBatch) | **GET** /submissions/batches/{submission_batch_id} | Check the status of a submission batch job
 *DocSpring.PDFApi* | [**getTemplate**](docs/PDFApi.md#getTemplate) | **GET** /templates/{template_id} | Check the status of an uploaded template
 *DocSpring.PDFApi* | [**getTemplateSchema**](docs/PDFApi.md#getTemplateSchema) | **GET** /templates/{template_id}/schema | Fetch the JSON schema for a template
+*DocSpring.PDFApi* | [**listCombinedSubmissions**](docs/PDFApi.md#listCombinedSubmissions) | **GET** /combined_submissions | Get a list of all combined submissions
 *DocSpring.PDFApi* | [**listFolders**](docs/PDFApi.md#listFolders) | **GET** /folders/ | Get a list of all folders
 *DocSpring.PDFApi* | [**listSubmissions**](docs/PDFApi.md#listSubmissions) | **GET** /submissions | List all submissions
 *DocSpring.PDFApi* | [**listSubmissions_0**](docs/PDFApi.md#listSubmissions_0) | **GET** /templates/{template_id}/submissions | List all submissions for a given template
@@ -186,6 +188,8 @@ Class | Method | HTTP request | Description
  - [DocSpring.Error](docs/Error.md)
  - [DocSpring.Folder](docs/Folder.md)
  - [DocSpring.FoldersFolder](docs/FoldersFolder.md)
+ - [DocSpring.FullTemplate](docs/FullTemplate.md)
+ - [DocSpring.FullTemplateDefaults](docs/FullTemplateDefaults.md)
  - [DocSpring.HtmlTemplateData](docs/HtmlTemplateData.md)
  - [DocSpring.InvalidRequest](docs/InvalidRequest.md)
  - [DocSpring.ListSubmissionsResponse](docs/ListSubmissionsResponse.md)
@@ -201,8 +205,6 @@ Class | Method | HTTP request | Description
  - [DocSpring.SubmissionDataBatchRequest](docs/SubmissionDataBatchRequest.md)
  - [DocSpring.SubmissionDataRequest](docs/SubmissionDataRequest.md)
  - [DocSpring.Template](docs/Template.md)
- - [DocSpring.Template1](docs/Template1.md)
- - [DocSpring.Template1Defaults](docs/Template1Defaults.md)
  - [DocSpring.TemplateData](docs/TemplateData.md)
  - [DocSpring.TemplatestemplateIdaddFieldsFields](docs/TemplatestemplateIdaddFieldsFields.md)
  - [DocSpring.UpdateDataRequestResponse](docs/UpdateDataRequestResponse.md)

package/docs/CombinedSubmission.md

@@ -3,6 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**errorMessage** | **String** |  | [optional] 
 **metadata** | **Object** |  | [optional] 
 **password** | **String** |  | [optional] 
 **expired** | **Boolean** |  | [optional] 
@@ -13,6 +14,7 @@ Name | Type | Description | Notes
 **submissionIds** | **[String]** |  | [optional] 
 **id** | **String** |  | [optional] 
 **state** | **String** |  | [optional] 
+**expiresIn** | **Number** |  | [optional] 
 **actions** | [**[CombinedSubmissionAction]**](CombinedSubmissionAction.md) |  | [optional] 
 
 

package/docs/{Template1.md → FullTemplate.md}

@@ -1,4 +1,4 @@
-# DocSpring.Template1
+# DocSpring.FullTemplate
 
 ## Properties
 Name | Type | Description | Notes
@@ -32,7 +32,7 @@ Name | Type | Description | Notes
 **sharedFieldData** | **Object** |  | [optional] 
 **documentMd5** | **String** |  | [optional] 
 **firstTemplate** | **Boolean** |  | [optional] 
-**defaults** | [**Template1Defaults**](Template1Defaults.md) |  | [optional] 
+**defaults** | [**FullTemplateDefaults**](FullTemplateDefaults.md) |  | [optional] 
 **editableSubmissions** | **Boolean** |  | [optional] 
 **expireSubmissions** | **Boolean** |  | [optional] 
 **name** | **String** |  | [optional] 

package/docs/{Template1Defaults.md → FullTemplateDefaults.md}

@@ -1,4 +1,4 @@
-# DocSpring.Template1Defaults
+# DocSpring.FullTemplateDefaults
 
 ## Properties
 Name | Type | Description | Notes

package/docs/PDFApi.md

@@ -17,6 +17,7 @@ Method | HTTP request | Description
 [**createPDFTemplate**](PDFApi.md#createPDFTemplate) | **POST** /templates | Create a new PDF template with a form POST file upload
 [**createPDFTemplateFromUpload**](PDFApi.md#createPDFTemplateFromUpload) | **POST** /templates?desc=cached_upload | Create a new PDF template from a cached presign upload
 [**deleteFolder**](PDFApi.md#deleteFolder) | **DELETE** /folders/{folder_id} | Delete a folder
+[**deleteTemplate**](PDFApi.md#deleteTemplate) | **DELETE** /templates/{template_id} | Delete a template
 [**expireCombinedSubmission**](PDFApi.md#expireCombinedSubmission) | **DELETE** /combined_submissions/{combined_submission_id} | Expire a combined submission
 [**expireSubmission**](PDFApi.md#expireSubmission) | **DELETE** /submissions/{submission_id} | Expire a PDF submission
 [**generatePDF**](PDFApi.md#generatePDF) | **POST** /templates/{template_id}/submissions | Generates a new PDF
@@ -28,6 +29,7 @@ Method | HTTP request | Description
 [**getSubmissionBatch**](PDFApi.md#getSubmissionBatch) | **GET** /submissions/batches/{submission_batch_id} | Check the status of a submission batch job
 [**getTemplate**](PDFApi.md#getTemplate) | **GET** /templates/{template_id} | Check the status of an uploaded template
 [**getTemplateSchema**](PDFApi.md#getTemplateSchema) | **GET** /templates/{template_id}/schema | Fetch the JSON schema for a template
+[**listCombinedSubmissions**](PDFApi.md#listCombinedSubmissions) | **GET** /combined_submissions | Get a list of all combined submissions
 [**listFolders**](PDFApi.md#listFolders) | **GET** /folders/ | Get a list of all folders
 [**listSubmissions**](PDFApi.md#listSubmissions) | **GET** /submissions | List all submissions
 [**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
 
 [api_token_basic](../README.md#api_token_basic)
 
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+<a name="deleteTemplate"></a>
+# **deleteTemplate**
+> UpdateTemplateResponse deleteTemplate(templateId)
+
+Delete a template
+
+### Example
+```javascript
+var DocSpring = require('docspring');
+var defaultClient = DocSpring.ApiClient.instance;
+
+// Configure HTTP basic authorization: api_token_basic
+var api_token_basic = defaultClient.authentications['api_token_basic'];
+api_token_basic.username = 'YOUR USERNAME';
+api_token_basic.password = 'YOUR PASSWORD';
+
+var apiInstance = new DocSpring.PDFApi();
+var templateId = tpl_000000000000000001; // String | 
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+apiInstance.deleteTemplate(templateId, callback);
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **templateId** | **String**|  | 
+
+### Return type
+
+[**UpdateTemplateResponse**](UpdateTemplateResponse.md)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
 ### HTTP request headers
 
  - **Content-Type**: Not defined
@@ -902,7 +951,7 @@ Name | Type | Description  | Notes
 
 <a name="getFullTemplate"></a>
 # **getFullTemplate**
-> Template1 getFullTemplate(templateId)
+> FullTemplate getFullTemplate(templateId)
 
 Fetch the full template attributes
 
@@ -936,7 +985,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**Template1**](Template1.md)
+[**FullTemplate**](FullTemplate.md)
 
 ### Authorization
 
@@ -1181,6 +1230,57 @@ Name | Type | Description  | Notes
 
 [api_token_basic](../README.md#api_token_basic)
 
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+<a name="listCombinedSubmissions"></a>
+# **listCombinedSubmissions**
+> [CombinedSubmission] listCombinedSubmissions(opts)
+
+Get a list of all combined submissions
+
+### Example
+```javascript
+var DocSpring = require('docspring');
+var defaultClient = DocSpring.ApiClient.instance;
+
+// Configure HTTP basic authorization: api_token_basic
+var api_token_basic = defaultClient.authentications['api_token_basic'];
+api_token_basic.username = 'YOUR USERNAME';
+api_token_basic.password = 'YOUR PASSWORD';
+
+var apiInstance = new DocSpring.PDFApi();
+var opts = {
+  'page': 2, // Number | Default: 1
+  'perPage': 1 // Number | Default: 50
+};
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+apiInstance.listCombinedSubmissions(opts, callback);
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **page** | **Number**| Default: 1 | [optional] 
+ **perPage** | **Number**| Default: 50 | [optional] 
+
+### Return type
+
+[**[CombinedSubmission]**](CombinedSubmission.md)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
 ### HTTP request headers
 
  - **Content-Type**: Not defined
@@ -1256,7 +1356,7 @@ var opts = {
   'cursor': sub_list_000012, // String | 
   'limit': 3, // Number | 
   'createdAfter': 2019-01-01T09:00:00-05:00, // String | 
-  'createdBefore': 2020-01-01T09:00:00-05:00, // String | 
+  'createdBefore': 2020-01-01T09:00:00.000+0200, // String | 
   'type': test, // String | 
   'includeData': true // Boolean | 
 };

package/docs/SubmissionData.md

@@ -6,6 +6,7 @@ Name | Type | Description | Notes
 **css** | **String** |  | [optional] 
 **data** | **Object** |  | 
 **dataRequests** | [**[CreateSubmissionDataRequestData]**](CreateSubmissionDataRequestData.md) |  | [optional] 
+**expiresIn** | **Number** |  | [optional] 
 **fieldOverrides** | **Object** |  | [optional] 
 **html** | **String** |  | [optional] 
 **metadata** | **Object** |  | [optional] 

package/docs/SubmissionDataRequest.md

@@ -4,6 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **String** |  | 
+**submissionId** | **String** |  | [optional] 
 **name** | **String** |  | 
 **email** | **String** |  | 
 **order** | **Number** |  | 

package/docs/TemplatestemplateIdaddFieldsFields.md

@@ -66,6 +66,7 @@ Name | Type | Description | Notes
 **qrcodeColorFieldRequired** | **Boolean** |  | [optional] 
 **currency** | **Boolean** |  | [optional] 
 **falseText** | **String** |  | [optional] 
+**placeholder** | **String** |  | [optional] 
 **strikethrough** | **Boolean** |  | [optional] 
 **characterSpacing** | **Number** |  | [optional] 
 **numberConditionRangeMax** | **Number** |  | [optional] 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docspring",
-  "version": "1.3.2",
+  "version": "1.5.0",
   "description": "An API client for the DocSpring PDF generation service",
   "license": "Unlicense",
   "main": "src/index.js",

package/src/ApiClient.js

@@ -32,7 +32,7 @@
 
   /**
    * @module ApiClient
-   * @version 1.3.2
+   * @version 1.5.0
    */
 
   /**